PublishingSystemManagerServices.DeleteTargets Method

PublishingSystemManagerServicesDeleteTargets Method

Ingeniux CMS Web Services API

Deletes collection of Publishing Targets

Namespace: IngeniuxCMService
Assembly: IngeniuxCMService (in IngeniuxCMService.dll) Version: 9.0.565.0 (9.0.565)

Syntax

C++

Copy

public XHRServiceResponseGeneric<PublishingTargetsDeleteResult> DeleteTargets(
	UniqueObjectsDeleteParam data
)

Public Function DeleteTargets ( 
	data As UniqueObjectsDeleteParam
) As XHRServiceResponseGeneric(Of PublishingTargetsDeleteResult)

public:
virtual XHRServiceResponseGeneric<PublishingTargetsDeleteResult^>^ DeleteTargets(
	UniqueObjectsDeleteParam^ data
) sealed

abstract DeleteTargets : 
        data : UniqueObjectsDeleteParam -> XHRServiceResponseGeneric<PublishingTargetsDeleteResult> 
override DeleteTargets : 
        data : UniqueObjectsDeleteParam -> XHRServiceResponseGeneric<PublishingTargetsDeleteResult>

Parameters

data

Type: UniqueObjectsDeleteParam

Object containing array of Id of Publishing Targets be deleted

Examples

Sample JSON input

JavaScript

Copy

{
    "data": {
        "selectedIds": ["PublishingTargets/34", "PublishingTargets/35"]
    }
}

Return Value

Type: XHRServiceResponseGenericPublishingTargetsDeleteResult

Object containing the Id of Publishing Targets that were actually deleted, and array of basic information on available Publishing Targets

Examples

Sample JSON return

JavaScript

Copy

{
    "code": 0,
    "error": null,
    "message": {
        "deletedIds": ["PublishingTargets\/34", "PublishingTargets\/35"],
        "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
        }, {
            "name": "Live2",
            "id": "PublishingTargets\/35",
            "dynamicPublish": true,
            "previewUrl": "DssPreview\/IGXDynamicPreview",
            "rootPageId": "x2",
            "structuredUrlEnabled": true
        }]
    }
}

Remarks

Non-existing Publishing Targets will be ignored. The returned list of delete Ids are Publishing Targets that exist.

Reference

PublishingSystemManagerServices Class

IngeniuxCMService Namespace