1. REST API Guide
  2. Using the Developer Workspace Parameter to Preview Changes Without Compiling to the Repository

Using the Developer Workspace Parameter to Preview Changes Without Compiling to the Repository

You can query active Siebel CRM objects by sending a HTTPS GET request to the resource’s URI. You can also preview changes to a specific object in a developer branch before you deliver them to the Main workspace. You can achieve this with the help of the developer workspace parameter, workspace&version. For more information about the developer workspace parameter, see About URI Parameters.

You must add a responsibility to Siebel Runtime Metadata Publisher Service in the Business Service Access List View for Workspace Inspect. Workspace Inspect internally uses this business service, and the 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 request fetches Quote Item details for a quote with the ID <Quote ID>:

  • URI: https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote Id>/QuoteItem

  • HTTP Method: GET

  • Content Type: application/json

  • Authorization: : Basic

  • Request body: None

Here are the response details for a successful request, displaying all the Quote Items for a specific Quote:

  • HTTP Code: 200

  • Content Type:

  • Response body: 

{
	"To Node": "",
    "Parent Product Id": "",
    .
    .
    .
    "Root Quote Item Id": "<Quote Item Id>",
    .
    .
    .
    "Service Account": "",
"Link": [
        {
            "rel": "self",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>",
            "name": "Quote Item"},
        {
            "rel": "canonical",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>",
            "name": "Quote Item"
        },
        {
            "rel": "parent",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>",
            "name": "Quote"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Contact",
            "name": "Contact"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/HTIM Audit Trail Item 2",
            "name": "HTIM Audit Trail Item 2"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote - Requested Schedule Lines.Line Number (Sequence)",
            "name": "Quote - Requested Schedule Lines.Line Number (Sequence)"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/PUB Evidence Quote Item",
            "name": "PUB Evidence Quote Item"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Approval History - Quote Item",
            "name": "Approval History - Quote Item"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/LOY Quote Point Types",
            "name": "LOY Quote Point Types"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Auto Quote Vehicles",
            "name": "Auto Quote Vehicles"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote - SAP 4x Schedule Line Item",
            "name": "Quote - SAP 4x Schedule Line Item"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote - Requested Schedule Lines",
            "name": "Quote - Requested Schedule Lines"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote - Promised Schedule Lines.Line Number (Sequence)",
            "name": "Quote - Promised Schedule Lines.Line Number (Sequence)"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote Item XA",
            "name": "Quote Item XA"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Price List",
            "name": "Price List"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote - Promised Schedule Lines",
            "name": "Quote - Promised Schedule Lines"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote Item Promotion Deal",
            "name": "Quote Item Promotion Deal"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/FS Quote Line Item Asset",
            "name": "FS Quote Line Item Asset"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Action",
            "name": "Action"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote Item Promotion Deal",
            "name": "Quote Item Promotion Deal"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Audit Trail Item 3",
            "name": "Audit Trail Item 3"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Activity Plan",
            "name": "Activity Plan"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Product Line",
            "name": "Product Line"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote Item XA",
            "name": "Quote Item XA"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Quote - SAP 4x Schedule Line Item",
            "name": "Quote - SAP 4x Schedule Line Item"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/Validation Message - Quote Item",
            "name": "Validation Message - Quote Item"
        },
        {
            "rel": "child",
            "href": "https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item/<Quote Item Id>/FS Quote Line Item Asset",
            "name": "FS Quote Line Item Asset"
        }
    ]
}

You can modify the object definition and then preview the changes before delivering the workspace. In the following example, Quote Item is no longer a child component of the base Quote integration object (IO). If you pass the workspace name and version number as query parameters in the request, this change to the structure of the IO can be seen. The response fetches an error due to inactivation of the Quote Item object.

For more information about how to inactivate an object in Web Tools, see Using Siebel Tools.

URI: https://<host_name>:<port_number>/siebel/v1.0/data/Quote/Quote/<Quote ID>/Quote Item?workspace=<workspace_name>&version=<ver_num>

{
    "ERROR": "Incorrect Business Component name 'Quote Item' or the Business Component is not mapped to any Integration Component in the Integration Object 'Base Quote'.(SBL-EAI-50257)"
}