Option search request
Description
This API searches for Option objects that satisfy the specified criteria.
API stability classification
API overview
HTTP | URI | Return | Return type |
|---|---|---|---|
POST | csm/Option/search | 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- | 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:
|
operationParams | 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- | Description |
|---|---|---|---|
criteria | 0..1 | Query criteria to filter the results. If you omit this parameter, all results are returned. | |
pageSize | Integer | 0..1 | Number of objects to return per page. When isOnboarded is set to false, this parameter is ignored and all results are returned in the response. |
pageNo | Integer | 0..1 | Page number to return. When isOnboarded is set to false, this parameter is ignored and all results are returned in the response. |
orderBy | String | 0..* | Name of an attribute or relationship on which to sort the results |
fillFields | String | 0..* | List of attributes and relationships to include in the response |
ignoreFields | String | 0..* | List of attributes and relationships to omit from the response |
isOnboarded | Boolean | 0..1 | Indicates whether to search for onboarded objects. When set to false, you must include providerURI. |
providerURI | String | 0..1 | URI of the provider in which to search for objects that are not onboarded. You must include this parameter when isOnboarded is set to false. |
If you include both the fillFields and ignoreFields parameters in your query and the same field is listed in both parameters, the ignoreFields parameter takes precedence.
"timeout": -1,
"postCallout": "",
"preCallout": ""
}
HTTP response message
Response message headers
This API uses only common headers listed in HTTP-request-and-response-headers.
Response message body
The response message body contains a SearchResults object in which the results field is an array of Option objects. If your search request times out before it finishes, the response message body contains a Task object.
{
"cloudClass": "com.bmc.cloud.model.beans.SearchResults",
"guid": "2e207804-33d4-4e43-b5c7-c3b378f11096",
"pageNo": 0,
"pageSize": -1,
"results": [
{
"cloudClass": "com.bmc.cloud.model.beans.Option",
"choiceSelectionMode": "SINGLE",
"description": "Created Option via REST call",
"fulfillmentDetails": "{\"class\":\"optionmap\",\"attributes\":{\"optionchoice\":[{\"effect\":[{\"change\":\"add\",\"optionvalue\":{\"useExternalDNS\":false,\"tags\":[{\"tag\":\"External\",\"taggroup\":\"NetworkType\"}],\"isdhcp\":false,\"nicnumber\":45,\"publicip\":false,\"ipForDNS\":null},\"path\":\"[class=deploymentmodel]/attributes/resourceset[name=Single Resource]/network/nics\"}],\"guid\":\"OI-a55d75f1412342e4b0a2d89d7051a91f\"}],\"optionreference\":{\"name\":\"AddNic\",\"guid\":\"OI-661f93f900a6498c922d0b57ace5447e\"}},\"version\":\"2.0\"}",
"guid": "cc56036a-aed1-453e-980f-9c5b97aeee94",
"isOnboarded": true,
"modifiedDate": 1518677840000,
"name": "AddNic",
"optionChoice": [
"/optionchoice/b0e5ac69-e33a-424d-9000-ecad574a9742"
],
"reconciliationID": "OI-661f93f900a6498c922d0b57ace5447e",
"requestableOffering": "/requestableoffering/OI-1a17b4f06c2340a591a4503e884b36e8",
"serviceOffering": [
"/serviceoffering/OI-1a17b4f06c2340a591a4503e884b36e8"
],
"tokenID": "0"
},
{
"cloudClass": "com.bmc.cloud.model.beans.Option",
"choiceSelectionMode": "SINGLE",
"fulfillmentDetails": "{\"version\":\"2.0\",\"attributes\":{\"optionreference\":{\"guid\":\"62892225-7BFF-AD6F-730E-13F5125E1F67\",\"name\":\"CPU\"},\"optionchoice\":[{\"guid\":\"A8F3B8B6-56F9-1DCA-0F0E-13F55DB046C9\",\"effect\":[{\"change\":\"replace\",\"path\":\"[class=deploymentmodel]/attributes/resourceset[tags.taggroup=ResourceSet&tags.tag=All]/compute/computecontainer/cpus\",\"optionvalue\":{\"policy\":\"No Less Than\",\"count\":1}}]},{\"guid\":\"C2ECBBF1-5894-BF94-159F-140E571716FF\",\"effect\":[{\"change\":\"replace\",\"path\":\"[class=deploymentmodel]/attributes/resourceset[tags.taggroup=ResourceSet&tags.tag=All]/compute/computecontainer/cpus\",\"optionvalue\":{\"policy\":\"No Less Than\",\"count\":2}}]},{\"guid\":\"5B5619F0-0D82-C8C4-21FD-140EEFEAEFC3\",\"effect\":[{\"change\":\"replace\",\"path\":\"[class=deploymentmodel]/attributes/resourceset[tags.taggroup=ResourceSet&tags.tag=All]/compute/computecontainer/cpus\",\"optionvalue\":{\"policy\":\"No Less Than\",\"count\":4}}]}]},\"class\":\"optionmap\"}",
"guid": "OI-99f0032b30984614b8ffe95b2adbd297",
"isOnboarded": true,
"modifiedDate": 1453740451000,
"name": "Quick Start - CPU",
"optionChoice": [
"/optionchoice/OI-08e61c4775414c4594eae8432cc522a2",
"/optionchoice/OI-311026eadb4544acbfb9d413d804f038",
"/optionchoice/OI-0a0b9259fa72448ea09b34d0fa4bcbcb"
],
"reconciliationID": "62892225-7BFF-AD6F-730E-13F5125E1F67",
"serviceOffering": [],
"tokenID": "OI-99f0032b30984614b8ffe95b2adbd297"
}
],
"totalRows": 2
}
]