PublishingSystemManagerServicesPublish Method

Performs a Publish on a Publishing Target

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

Syntax

public XHRServiceResponseGeneric<PublishResult> Publish(
	string contentItemId,
	string pubTargetId,
	bool incremental,
	bool includeChildren,
	bool sitePublish,
	bool replicate,
	bool forceIncremental,
	DitaDependenciesParameterChoices[] dependencies
)

Public Function Publish ( 
	contentItemId As String,
	pubTargetId As String,
	incremental As Boolean,
	includeChildren As Boolean,
	sitePublish As Boolean,
	replicate As Boolean,
	forceIncremental As Boolean,
	dependencies As DitaDependenciesParameterChoices()
) As XHRServiceResponseGeneric(Of PublishResult)

public:
virtual XHRServiceResponseGeneric<PublishResult^>^ Publish(
	String^ contentItemId, 
	String^ pubTargetId, 
	bool incremental, 
	bool includeChildren, 
	bool sitePublish, 
	bool replicate, 
	bool forceIncremental, 
	array<DitaDependenciesParameterChoices^>^ dependencies
) sealed

abstract Publish : 
        contentItemId : string * 
        pubTargetId : string * 
        incremental : bool * 
        includeChildren : bool * 
        sitePublish : bool * 
        replicate : bool * 
        forceIncremental : bool * 
        dependencies : DitaDependenciesParameterChoices[] -> XHRServiceResponseGeneric<PublishResult> 
override Publish : 
        contentItemId : string * 
        pubTargetId : string * 
        incremental : bool * 
        includeChildren : bool * 
        sitePublish : bool * 
        replicate : bool * 
        forceIncremental : bool * 
        dependencies : DitaDependenciesParameterChoices[] -> XHRServiceResponseGeneric<PublishResult>

Parameters

contentItemId String: Root Page Id for Publishing
pubTargetId String: Publishing Target Id
incremental Boolean: Whether to publich changes only, or perform full site publish
includeChildren Boolean: Include descendants of the Root Page or not
sitePublish Boolean: Whether this is a publishing a full site, or just specified page (with or without descendants)
replicate Boolean: Whether to perform replication after publishing
forceIncremental Boolean: Whether to bypass change time checking. Only applies to increment publish
dependencies DitaDependenciesParameterChoices: DITA dependencies parameter choices controlling which dependencies are included with this publish.

Return Value

XHRServiceResponseGenericPublishResult

Result of Publishing submission

Example

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "includeChildren": true,
        "incremental": true,
        "pageId": "x2",
        "pubTargetName": "Live",
        "targetId": "PublishingTargets\/1"
    }
}

Remarks

If Publishing Target doesn't exist, returns error status

If Root Page Id is not specified, uses the Root Page of the Publishing Target

If "sitePublish" is true, do a full site publish on the Target, otherwise, it is a Page only publish with or without descendants

Reference

PublishingSystemManagerServices Class

IngeniuxCMService Namespace