SWI Product Class Operations
For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
QueryPage |
Queries high-volume, existing product classes using the QueryPage method. |
|
QueryById |
Queries for a single existing product class using Row ID. |
|
QueryByExample |
Queries for existing product classes matching the criteria provided in the request. |
Message Description: SWI Product Class - QueryPage
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
PageSize |
Default is 10. Indicates the maximum number of integration object instances to be returned. |
String |
|
StartRowNum |
Default is 0 (first page). Indicates the row in the result set for the QueryPage method to start retrieving a page of records. |
String |
|
searchSpec |
String containing the search specification. |
String |
|
ViewMode |
Default is All. You must apply Visibility mode to the business object. Valid values are:
Note: The ViewMode user property on the integration object has priority over the ViewMode
method argument.
|
String |
|
SiebelMessage |
The input or the output integration object instance. |
Integration Object |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
LastPage |
Boolean indicating whether or not the last record in the query result set has been returned. |
String |
|
ListOfSWIAdmin ISS Product Definition |
An instance of the integration object SWIAdminISSProductDefinition. |
Integration Component |
|
SWI ISS Class VOD BusComp |
An integration component corresponding to the internal Product business component. You can position SWI ISS Class VOD BusComp under ListOfSWIAdminISSClassDefinitionIO at one time. |
Integration Component |
|
Name |
Product class name. |
String |
|
Price Type |
Pricing type, for example, Recurring. |
String |
|
Vod Name |
Product name. |
String |
|
Vod ID |
The product class object ID. |
String |
|
Vod Name |
The record ID in the external system. |
String |
|
Active Flag |
Indicates if the product class is active. |
String |
|
Locked Flag |
Indicates if the product class is locked. |
String |
|
ListOfSWI ISS Product Attribute VBC |
Container element for the product structure information. |
Integration Component |
|
Name |
Name of the attribute in the class. |
String |
|
Attribute Name |
The attribute definition name. |
String |
|
Default Value |
The default value of the attribute. |
String |
|
ListOfSWI ISS Attribute Definition Lang BusComp |
Container element for the price list item information. |
Integration Component |
|
Vod Name |
Attribute name. |
String |
|
Lang CD |
Language code. |
String |
|
ListOfSWI ISS Product Details BusComp |
Container element for the product details. |
Integration Component |
|
Object Name |
The product name. |
String |
|
Object ID |
The product ID. |
String |
|
Last Page |
Indicates if the user needs to continue the query for the next set of records, or if this is the last page. |
String |
Message Description: SWI Product Class - QueryById
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
PrimaryRowId |
The product class row ID. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWIAdmin ISS Product Definition |
An instance of the integration object SWIAdminISSProductDefinition. |
Integration Component |
|
SWI ISS Class VOD BusComp |
An integration component corresponding to the internal Product business component. You can position SWI ISS Class VOD BusComp under ListOfSWIAdminISSClassDefinitionIO at one time. |
Integration Component |
|
Name |
Product class name. |
String |
|
Price Type |
Pricing type, for example, Recurring. |
String |
|
Vod Name |
Product name. |
String |
|
Vod ID |
The class object ID. |
String |
|
Vod Name |
The record ID in the external system. |
String |
|
Active Flag |
Indicates if the class is active. |
String |
|
Locked Flag |
Indicates if the class is locked. |
String |
|
ListOfSWI ISS Product Attribute VBC |
Container element for the product structure information. |
Integration Component |
|
Name |
Name of the attribute in the class. |
String |
|
Attribute Name |
The attribute definition name. |
String |
|
Default Value |
The default value of the attribute. |
String |
|
ListOfSWI ISS Attribute Definition Lang BusComp |
Container element for the price list item information. |
Integration Component |
|
Vod Name |
Attribute name. |
String |
|
Lang CD |
Language code. |
String |
|
ListOfSWI ISS Product Details BusComp |
Container element for the product details. |
Integration Component |
|
Object Name |
The product name. |
String |
|
Object ID |
The product ID. |
String |
Message Description: SWI Product Class - QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWIAdminISSClassDefinitionIO |
An instance of the integration object ListOfSWIAdminISSClassDefinitionIO. |
Integration Component |
|
Name |
Name of the product to query. |
String |
|
External Integration Id |
The product ID from the external system. |
String |
|
searchSpec |
String containing the search specification. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWIAdmin ISS Product Definition |
An instance of the integration object SWIAdminISSProductDefinition. |
Integration Component |
|
SWI ISS Class VOD BusComp |
An integration component corresponding to the internal Product business component. You can position SWI ISS Class VOD BusComp under ListOfSWIAdminISSClassDefinitionIO at one time. |
Integration Component |
|
Name |
Product class name. |
String |
|
Price Type |
Pricing type, for example, Recurring. |
String |
|
Vod Name |
Product name. |
String |
|
Vod ID |
The product class object ID. |
String |
|
Vod Name |
The record ID in the external system. |
String |
|
Active Flag |
Indicates if the product class is active. |
String |
|
Locked Flag |
Indicates if the product class is locked. |
String |
|
ListOfSWI ISS Product Attribute VBC |
Container element for the product structure information. |
Integration Component |
|
Name |
Name of the attribute in the class. |
String |
|
Attribute Name |
The attribute definition name. |
String |
|
Default Value |
The default value of the attribute. |
String |
|
ListOfSWI ISS Attribute Definition Lang BusComp |
Container element for the price list item information. |
Integration Component |
|
Vod Name |
Attribute name. |
String |
|
Lang CD |
Language code. |
String |
|
ListOfSWI ISS Product Details BusComp |
Container element for the product details. |
Integration Component |
|
Object Name |
The product name. |
String |
|
Object ID |
The product ID. |
String |