LogicalCommunicationPath bulkDelete request

Description

This API deletes multiple logical communication paths in a best-effort manner. The processing will not stop in the event of failure, but will attempt to clean up as many paths and database objects as possible.
The API is only to be used if a call to the LogicalCommunicationPath bulkDecommission fails and a clean-up is required.

API stability classification

Unstable

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/LogicalCommunicationPath/bulkDelete	void	Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP-request-and-response-headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name	Type	Multi- plicity	Description
callbackURL	String	0..1	URL to call when the operation finishes
postCallout	String	0..1	Identifier of a callout to run after the operation executes
preCallout	String	0..1	Identifier of a callout to run before the operation executes
timeout	Integer	0..1	Timeout setting. For more information about using the timeout, see Synchronous-and-asynchronous-operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
operationParams	OperationParameter	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing-input-parameters-with-an-API-request.

Input parameters to include in operationParams

Name	Type	Multi- plicity	Description
eligibleLogicalHostingEnvironment	LogicalHostingEnvironment	1	The LogicalHostingEnvironment object with which the LogicalCommunicationPath objects are associated
logicalCommunicationPath	LogicalCommunicationPath	1..*	List of logical communication paths to delete

HTTP response message

Response message headers