Space banner This version of the product is in limited support. However, the documentation is available for your convenience. You will not be able to leave comments.

Reviewing and testing REST Web APIs

The following HTTP methods are supported in BMC Client Management:

  • GET: List the URIs and perhaps other details of the collection's members if executed on a collection URI, or retrieve a representation of the addressed member of the collection, expressed in an appropriate Internet media type if executed on an individual element.
  • POST: Create a new entry in the collection. The new entry's URI is assigned automatically and is usually returned by the operation. This method is mainly used on a collection URI not for execution on an individual element. If run on an individual element it treats the addressed member as a collection in its own right and creates a new entry in it.
  • PUT: Replace the entire collection with another collection if executed on a collection URI. If executed on an individual element it replaces the addressed member of the collection, or if it doesn't exist, creates it.
  • DELETE: Delete the entire collection or the addressed member of the collection.

Related topics

Setting-the-Web-API-module-parameters

Security in REST Web APIs

The REST API uses the JSON encoding. The API has no knowledge of the purpose it is going to be used for. It ensures only JSON encoding and returns data verbatim. As the data can be used for different purposes, we recommend that you encode the data either before sending it to the API or after collecting it from the API.

The following are the use cases.

REST_API_usecases.png

To test the web service

BMC Client Management provides a tool to review and test the REST web API operations available for interaction with BMC Client Management database. 

  1. In a browser window, enter the tool URI in the https://server:port/wsdoc format. For example,http://scotty:1611 or http://localhost:1611.

  2. For authentication, click Authorize. A popup displays. 

    Swagger_login.png

  3. On the popup, enter username and password and click Authorize.

    The access to the BMC Client Management database is now granted.

    Note

    If your credentials contain domain name, enter the credentials in the following format: [domain]\\[username] (with two '\'). For example,production\\administrator.

  4. To access the operations, click the respective group link and the available operations are listed.
    Swagger_api.png

    Click the screenshot to view it in higher resolution.

  5. To test an operation, click Try it out.
    All the fields are now enabled for editing. 
  6. Change the values of the required fields and click Execute. 
    swagger_execute.png
    The test result is displayed.
    swagger_result.png
  7. Click Clear if you want to clear the data and start the test again.

For more information about supported REST web services operations, download and see the BMC Client Management - Web Services Operations Manual  for Integration with BMC Client Management.

 

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