SWI Product Operations
For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
QueryPage |
Queries for existing products using the QueryPage method. |
|
QueryById |
Queries for existing products using Row ID. |
|
QueryByExample |
Queries for existing catalogs using the QueryByExample method. |
Message Description: SWI Product - 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 |
|
ListOfSWI Admin ISS Product Definition |
An instance of the integration object SWI Admin ISS Product Definition. |
Integration Component |
|
SWI Internal Product VOD |
An integration component (XML tag) corresponding to the Internal Product business component. You can position one SWI Internal Product VOD under ListOfSWI Admin ISS Product Definition at one time. |
Integration Component |
|
Name |
Name of the product. |
String |
|
Price Type |
Pricing Type, for example Recurring. |
String |
|
External Integration Id |
The record ID in the external system. |
String |
|
Product Def Type Code |
The product definition type, for example, Customizable. |
String |
|
ListOfSWI ISS Product VOD BusComp |
Container element for the product structure information. |
Integration Component |
|
Vod Name |
Name of the product. |
String |
|
ListOfPrice List Item |
Price list item information. |
Integration Component |
|
List Price |
The listed price. |
String |
|
ListOfProduct Compatibility - Subject |
The compatibility rules under which this product is the subject. |
Integration Component |
|
Type |
Type of the compatibility rule. |
String |
|
Adjustment Group |
The adjustment group. |
String |
|
ListOfSWI Product User Defined Attribute |
User-defined attributes |
Integration Component |
|
Name |
Name of the attribute. |
String |
|
Value |
Value of the attribute. |
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 - QueryById
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
PrimaryRowId |
The row ID of the product. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWI Admin ISS Product Definition |
An instance of the integration object SWI Admin ISS Product Definition. |
Integration Component |
|
SWI Internal Product VOD |
An integration component (XML tag) corresponding to the Internal Product business component. You can position one SWI Internal Product VOD under ListOfSWI Admin ISS Product Definition at one time. |
Integration Component |
|
Name |
Name of the product. |
String |
|
Price Type |
Pricing type, for example Recurring. |
String |
|
External Integration Id |
The record ID in the external system. |
String |
|
Product Def Type Code |
The product definition type, for example, Customizable. |
String |
|
ListOfSWI ISS Product VOD BusComp |
Container element for the product structure information. |
Integration Component |
|
Vod Name |
Name of the product. |
String |
|
ListOfPrice List Item |
Price list item information. |
Integration Component |
|
List Price |
The listed price. |
String |
|
ListOfProduct Compatibility - Subject |
The compatibility rules under which this product is the subject. |
Integration Component |
|
Type |
Type of the compatibility rule. |
String |
|
Adjustment Group |
The adjustment group. |
String |
|
ListOfSWI Product User Defined Attribute |
User-defined attributes. |
Integration Component |
|
Name |
Name of the attribute. |
String |
|
Value |
Value of the attribute. |
String |
Message Description: SWI Product - QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWI ISS Product VOD BusComp |
An instance of the integration object SWI Admin ISS Product Definition. |
Integration Component |
|
Name |
Name of the catalog to be queried. |
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 |
|---|---|---|
|
ListOfSWI Admin ISS Product Definition |
An instance of the integration object SWI Admin ISS Product Definition. |
Integration Component |
|
SWI Internal Product VOD |
An integration component (XML tag) corresponding to the Internal Product business component. You can position one SWI Internal Product VOD under ListOfSWI Admin ISS Product Definition at one time. |
Integration Component |
|
Name |
Name of the product. |
String |
|
Price Type |
Pricing Type, for example Recurring. |
String |
|
External Integration Id |
The record ID in the external system. |
String |
|
Product Def Type Code |
The product definition type, for example, Customizable. |
String |
|
ListOfSWI ISS Product VOD BusComp |
Container element for the product structure information. |
Integration Component |
|
Vod Name |
Name of the product. |
String |
|
ListOfPrice List Item |
Price list item information. |
Integration Component |
|
List Price |
The listed price. |
String |
|
ListOfProduct Compatibility - Subject |
The compatibility rules under which this product is the subject. |
Integration Component |
|
Type |
Type of compatibility rule. |
String |
|
Adjustment Group |
The adjustment group. |
String |
|
ListOfSWI Product User Defined Attribute |
User-defined attributes. |
Integration Component |
|
Name |
Name of the attribute. |
String |
|
Value |
Value of the attribute. |
String |