Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

ServiceOffering search request


Description

This API searches for ServiceOffering objects that satisfy the specified criteria.

API stability classification

Uncommitted

API overview

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

Input parameters to include in operationParams

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.

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 ServiceOffering objects. If your search request times out before it finishes, the response message body contains a Task object.

Example

The following example shows an HTTP request to search for service offering instances named New service offering.


POST /csm/serviceoffering/search
Host: apiServer.calbro.com:8080
Authentication-Token: yourToken

{
 "callbackURL":"",
 "operationParams":[
    {
     "multiplicity":"1",
     "name":"criteria",
     "type":"com.bmc.cloud.model.beans.QueryNode",
     "value":{
       "children":[
          {
           "children":[
              {
               "cloudClass":"com.bmc.cloud.model.beans.QueryNode",
               "guid":"3ebb1c4e-1255-412a-8009-9e1041d9fb5f",
               "nodeType":"QueryPropertyReference",
               "references":[
                 "name"
                ]
              },
              {
               "cloudClass":"com.bmc.cloud.model.beans.QueryNode",
               "guid":"5789076e-bd02-49bd-b627-b7ebc3b3af7e",
               "nodeType":"QueryLiteral",
               "type":"java.lang.String",
               "values":[
                 "New service offering"
                ]
              }
            ],
           "cloudClass":"com.bmc.cloud.model.beans.QueryNode",
           "guid":"02774474-7f22-4e06-a452-7dcb129b590d",
           "nodeType":"QuerySimpleCondition",
           "simpleOperator":"EQUALS"
          }
        ],
       "cloudClass":"com.bmc.cloud.model.beans.QueryNode",
       "fromClass":"com.bmc.cloud.model.beans.ServiceOffering",
       "nodeType":"QuerySelect"
      }
    }
  ],
 "postCallout":"",
 "preCallout":"",
 "timeout":-1
}

The following example shows the HTTP response to the previous request. The JSON document contains information about two service offerings with the name New service offering.


Status Code: 200 OK
BMC-Transaction-ID: 11d27bc4-74a8-4112-8962-f612b3fed2d5
Content-Length: 1263
Content-Type: application/json; charset=UTF-8
Date: Fri, 25 Jan 2013 23:10:23 GMT
Server: Jetty(6.1.x)
Session-ID: 76dba560-beda-4519-b1c2-9225a8931599

[
  {
   "cloudClass":"com.bmc.cloud.model.beans.SearchResults",
   "guid":"00ab5a44-12fa-4dd1-9795-20d7c6432254",
   "pageNo":0,
   "pageSize":0,
   "results":[
      {
       "cloudClass":"com.bmc.cloud.model.beans.ServiceOffering",
       "deploymentModel":"/deploymentmodel/OI-72E5A98669CC4F6D8F1E9D3F408483EB",
       "functionalModel":"/functionalmodel/OI-7D677E49FA7D4ED18264DFB99520F420",
       "guid":"OI-150C3D6AA05A40D0A7F7588418FA5ED4",
       "isOnboarded":true,
       "name":"New Service Offering",
       "option":[
         "/option/OI-FA195EF868E44C7EAF25AB030A733650"
        ],
       "reconciliationID":"OI-63b9b6d112474eff967cfbfeabedfba1",
       "tokenID":"IDGFFN7NA12J8AMHZPBU9UM10GK77J"
      },
      {
       "cloudClass":"com.bmc.cloud.model.beans.ServiceOffering",
       "deploymentModel":"/deploymentmodel/OI-077B966BA2CD4B69BD9021805DDE52BD",
       "functionalModel":"/functionalmodel/OI-B5FFBF99358045849550F592245575CF",
       "guid":"OI-93D42710A4D642888CAFEFEFC1ACBD90",
       "isOnboarded":true,
       "name":"New Service Offering",
       "option":[
         "/option/OI-B4B9ED3567D24CFC88155507A59F4902"
        ],
       "reconciliationID":"OI-f2c0400685ee48dbb2d70dcffe119fb8",
       "tokenID":"IDGFFN7NA12J8AM0UZDS3JI3T6WZAT"
      }
    ],
   "totalRows":2
  }
]

 

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*