SWI Product Attribute Operations
For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
QueryPage |
Queries high-volume, existing product attributes using the QueryPage method. |
|
QueryById |
Queries for single existing product attribute using Row ID. |
|
QueryByExample |
Queries existing product attributes matching the criteria provided in the request. |
Message Description: SWI Product Attribute - 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 |
|
ListOfSWIAdminISSAttributeDefnIO |
An instance of the integration object SWIAdminISSAttributeDefnIO. |
Integration Object |
|
SWI Attribute VOD BusComp |
An integration component corresponding to the internal Product business component. You can position one SWI Attribute VOD BusComp under ListOfSWIAdminISSClassDefinitionIO at one time. |
Integration Component |
|
Name |
Name of the class. |
String |
|
Vod Id |
The class object ID. |
String |
|
Vod Name |
The record id in the external system. |
String |
|
Vod Type |
The versioned object type. |
String |
|
Active Flag |
Indicates if the class is active. |
String |
|
Locked Flag |
Indicates if the class is locked. |
String |
|
ListOfSWI Attribute Details BusComp |
Container element for the attribute detail information. |
Integration Component |
|
Data Type |
Indicates the attribute data type, for example, String or Integer. |
String |
|
Domain Type |
Indicates the attribute domain type, for example, Enumerated. |
String |
|
Max Value |
The maximum attribute value. |
String |
|
Min Value |
The minimum attribute value. |
String |
|
Unit of Measure |
The unit measure of the attribute. |
String |
|
ListOfSWI ISS Attribute Definition Lang BusComp |
Language information of the attribute. |
Integration Component |
|
Vod Name |
The attribute name. |
String |
|
Lang CD |
Language code. |
String |
|
ListOfSWI Attribute Values BusComp |
Container element for the domain values of the attribute. |
Integration Component |
|
Value |
The attribute value. |
String |
|
Sequence |
Sequence number of the attribute value. |
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 Attribute - 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 attribute. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWIAdminISSAttributeDefnIO |
An instance of the integration object SWIAdminISSAttributeDefnIO. |
Integration Object |
|
SWI Attribute VOD BusComp |
An integration component corresponding to the internal Product business component. You can position one SWI Attribute VOD BusComp under ListOfSWIAdminISSClassDefinitionIO at one time. |
Integration Component |
|
Name |
Name of the class. |
String |
|
Vod Id |
The class object ID. |
String |
|
Vod Name |
The record id in the external system. |
String |
|
Vod Type |
The versioned object type. |
String |
|
Active Flag |
Indicates if the class is active. |
String |
|
Locked Flag |
Indicates if the class is locked. |
String |
|
ListOfSWI Attribute Details BusComp |
Container element for the attribute detail information. |
Integration Component |
|
Data Type |
Indicates the attribute data type, for example, String or Integer. |
String |
|
Domain Type |
Indicates the attribute domain type, for example, Enumerated. |
String |
|
Max Value |
The maximum attribute value. |
String |
|
Min Value |
The minimum attribute value. |
String |
|
Unit of Measure |
The unit measure of the attribute. |
String |
|
ListOfSWI ISS Attribute Definition Lang BusComp |
Language information of the attribute. |
Integration Component |
|
Vod Name |
The attribute name. |
String |
|
Lang CD |
Language code. |
String |
|
ListOfSWI Attribute Values BusComp |
Container element for the domain values of the attribute. |
Integration Component |
|
Value |
The attribute value. |
String |
|
Sequence |
Sequence number of the attribute value. |
String |
Message Description: SWI Product Attribute - QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWIAdminISSAttributeDefnIO |
An instance of the integration object SWIAdminISSAttributeDefnIO. |
Integration Object |
|
VOD Name |
Attribute name to be queried. |
String |
|
External Integration Id |
The attribute 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 |
|---|---|---|
|
ListOfSWIAdminISSAttributeDefnIO |
An instance of the integration object SWIAdminISSAttributeDefnIO. |
Integration Object |
|
SWI Attribute VOD BusComp |
An integration component corresponding to the internal Product business component. You can position one SWI Attribute VOD BusComp under ListOfSWIAdminISSClassDefinitionIO at one time. |
Integration Component |
|
Name |
Name of the class. |
String |
|
Vod Id |
The class object ID. |
String |
|
Vod Name |
The record id in the external system. |
String |
|
Vod Type |
The versioned object type. |
String |
|
Active Flag |
Indicates if the class is active. |
String |
|
Locked Flag |
Indicates if the class is locked. |
String |
|
ListOfSWI Attribute Details BusComp |
Container element for the attribute detail information. |
Integration Component |
|
Data Type |
Indicates the attribute data type, for example, String or Integer. |
String |
|
Domain Type |
Indicates the attribute domain type, for example, Enumerated. |
String |
|
Max Value |
The maximum attribute value. |
String |
|
Min Value |
The minimum attribute value. |
String |
|
Unit of Measure |
The unit measure of the attribute. |
String |
|
ListOfSWI ISS Attribute Definition Lang BusComp |
Language information of the attribute. |
Integration Component |
|
Vod Name |
The attribute name. |
String |
|
Lang CD |
Language code. |
String |
|
ListOfSWI Attribute Values BusComp |
Container element for the domain values of the attribute. |
Integration Component |
|
Value |
The attribute value. |
String |
|
Sequence |
Sequence number of the attribute value. |
String |