PublishingSystemManagerServicesPublish Method

Ingeniux CMS Web Services API

Performs a Publish on a Publishing Target

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

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

Parameters

contentItemId
Type: SystemString
Root Page Id for Publishing
pubTargetId
Type: SystemString
Publishing Target Id
incremental
Type: SystemBoolean
Whether to publich changes only, or perform full site publish
includeChildren
Type: SystemBoolean
Include descendants of the Root Page or not
sitePublish
Type: SystemBoolean
Whether this is a publishing a full site, or just specified page (with or without descendants)
replicate
Type: SystemBoolean
Whether to perform replication after publishing
forceIncremental
Type: SystemBoolean
Whether to bypass change time checking. Only applies to increment publish

Return Value

Type: XHRServiceResponseGenericPublishResult

Result of Publishing submission

Examples

Sample JSON return
JavaScript
{
    "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

See Also

Reference