Database getQualifiedHostingContainers request (Provider API)

Description

If this SoftwareContainer is supported, then return the subset of candidateHostingContainers that qualify as hosts. Otherwise, return an error that indicates this SoftwareContainer is not supported. The semantics of a "qualifying host" is provider-dependent and may consider any substantive attributes of the software containers (but not attributes such as guid, name, description, externalId, isOnboarded, etc.)

API stability classification

Unassigned

API overview

HTTP method	URI	Return type	Return type multiplicity
POST	csm/Database/guid/getQualifiedHostingContainers	SoftwareContainer	0..*

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
candidateHostingContainers	SoftwareContainer	0..*

HTTP response message

Response message headers