1. REST API Guide
  2. Using the Describe Workspace Parameter to Preview the Modified OpenAPI Specification of a Business Service Method Without Compiling to the Repository

Using the Describe Workspace Parameter to Preview the Modified OpenAPI Specification of a Business Service Method Without Compiling to the Repository

You may need to preview or inspect the modified OpenAPI specification of changes to a business service in a developer workspace branch before you deliver these changes to the Main workspace. You can achieve this by using the /describe parameter, and the developer workspace parameter, workspace&version. For more information, see About URI Parameters.

Note: This feature is useful when developing and testing repository changes.

You must add a responsibility to Siebel Runtime Metadata Publisher Service in the Business Service Access List View for Workspace Inspect. Workspace Inspect uses this business service internally, and this responsibility is needed for Workspace Inspect to work correctly. For more information about associating a Business Service with a responsibility, see Configuring Business Service Methods for REST Access and Siebel Security Guide.

The following example uses the Siebel CRM Business Service Siebel Account, and QueryById method.

First, the standard Siebel Business Service method argument SiebelMessage points to the integration object (and output argument): Account Interface. When we generate the OpenAPI specification of this method using the /describe parameter, the specification output is: Account Interface IO.

Next, you create a workspace in Web Tools. In this example we use: dev_sadmin_mytestws. You must update the Siebel Business Service method argument SiebelMessage to a different integration object, in this case: Account IO. Version the workspace, creating the workspace: version 1.

Without delivering the workspace, use REST API to preview the modified OpenAPI specification of this method, using the following parameters:

  • /describe

  • workspace=dev_sadmin_mytestws&version=1

  • URI: https://ServerName:port/siebel/v1.0/service/Siebel Account/QueryById/describe?workspace=dev_sadmin_mytestws&version=1

  • HTTP Method: GET

  • Content Type: application/json

  • Authorization: : Basic

Here are the response details for a successful request:

  • HTTP Code: 200

  • Content Type: application/json

  • Response body: The response body contains the OpenAPI specification of the method, all its input and output arguments, and integration objects, if applicable. The specification for the business service method output is: Account IO. This is because we updated version 1 of the workspace.

Next, in Web Tools, update the Siebel Business Service method argument SiebelMessage with a different integration object. This time with the name: Account_EMR. Version the workspace, creating the workspace: version 2.

Without delivering the workspace, you can preview the modified OpenAPI specification of this method using REST API and the following parameters:

  • /describe

  • workspace=dev_sadmin_mytestws&version=2

The received response is in the form Account_EMR, as described in the following example:

  • URI: https://ServerName:port/siebel/v1.0/service/Siebel Account/QueryById/describe?uniformresponse=y&workspace=dev_sadmin_mytestws&version=1

  • HTTP Method: GET

  • Content Type: application/json

  • Authorization :Basic

Here are the partial response details for a successful request, where the output integration object is Account_EMR:

  • HTTP Code: 200

  • Content Type: application/json

  • Response body: The response body contains the OpenAPI specification of the method, all its input and output arguments, and integration objects, if applicable. The specification for the business service method output is Account_EMR. This is because we updated version 2 of the workspace.