SWI Product Line Operations
For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
|
Insert |
Creates a product line. |
|
InsertOrUpdate |
Creates a new product line or updates an existing product line |
|
Synchronize |
Synchronizes a new product line, or synchronizes data to an existing product line. |
|
QueryById |
Queries for existing product lines using Row ID. |
|
QueryByExample |
Queries for existing product lines using the QueryByExample method. |
| QueryPage | Queries for existing product lines using the QueryPage method. |
|
Delete |
Deletes a product line. |
Message Description: SWI Product Line Service - Insert
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
AdminProductLine |
An integration component (XML tag) corresponding to the Admin Product Line business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. |
Integration Component |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
Division |
Division within the company. |
String |
|
ListofAdminProductLine_ InternalProduct |
Container element for internal products associated with the product line. |
Integration Component |
|
Product |
Product name. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
Primary Organization |
The primary organization for the product. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
AdminProductLine |
An integration component (XML tag) corresponding to the Admin Product Line business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. |
Integration Component |
|
Id |
Product line ID. |
String |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
PrimaryPositionId |
Primary position ID. |
String |
|
PrimaryProductId |
ID of the primary product. |
String |
Message Description: SWI Product Line - InsertOrUpdate
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
ListofAdminProductLine_Position |
Container element for positions associated with the product line. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
Division |
Division within the company. |
String |
|
ListofAdminProductLine_ InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
Product |
Product name. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
Primary Organization |
The primary organization for the product. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
AdminProductLine |
An integration component (XML tag) corresponding to the Admin Product Line business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. |
Integration Component |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
AdminProductLine_Position IsPrimaryMVG |
An instance of the Admin Product Line_Position integration component that corresponds to a primary MVG. It is denoted by the attribute IsPrimaryMVG and is set to Y. This attribute is a hidden integration component field, and it does not have a corresponding business component field. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
Division |
Division within the company. |
String |
|
ListofAdminProductLine_ InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
Product |
Product name. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
Primary Organization |
The primary organization for the product. |
String |
Message Description: SWI Product Line - Synchronize
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
Division |
Division within the company. |
String |
|
ListofAdminProductLine_ InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
Product |
Product name. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
Primary Organization |
The primary organization for the product. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
Id |
Product line ID. |
String |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
PrimaryPositionId |
Primary Position ID. |
String |
|
PrimaryProductId |
ID of the primary product. |
String |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
PositionId |
Position ID. |
String |
|
PrimaryEmployeeId |
ID of the primary employee. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
Division |
Division within the company. |
String |
|
ListofAdminProductLine_ InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
Product |
Product name. |
String |
|
Part |
Part number. |
String |
|
Primary Organization |
The primary organization for the product. |
String |
Message Description: SWI Product Line - 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 line. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
AdminProductLine |
An integration component (XML tag) corresponding to the Admin Product Line business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. |
Integration Component |
|
Description |
Description of the product line. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
Name |
Name of the product line. |
String |
|
PrimaryPositionId |
ID of the primary position. |
String |
|
ListOfAdminProductLine_Position |
An instance of the integration object Admin Product Line_Position. |
Integration Object |
|
AdminProductLine_Position IsPrimaryMVG |
An instance of the Admin Product Line_Position integration component that corresponds to a primary MVG. It is denoted by the attribute IsPrimaryMVG and is set to Y. This attribute is a hidden integration component field, and it does not have a corresponding business component field. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
Position_Id |
ID of the position. |
String |
|
PrimaryEmployeeId |
ID of the primary employee. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
WorkPhoneNumber |
Work phone number. |
String |
|
DivisionIntegrationId |
Division integration ID. |
String |
|
Division |
Division within the company. |
String |
|
ListOfAdminProductLine_InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
AdminProductLine_InternalProductIsPrimaryMVG |
An instance of the Admin Product Line_Internal integration component that corresponds to a primary MVG. It is denoted by the attribute IsPrimaryMVG and is set to Y. This attribute is a hidden integration component field, and it does not have a corresponding business component field. |
Integration Component |
|
Product |
Product name. |
String |
|
Part |
Part number. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
PrimaryOrganization |
The primary organization for the product. |
String |
|
VendorIntegrationId |
Integration ID of the vendor. |
String |
Message Description: SWI Product Line - QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfSWI Admin Product Line |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
Admin Product Line |
Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. |
Integration Component |
|
Id |
Product ID |
String |
|
Created |
System timestamp |
String |
|
Updated |
System timestamp |
String |
|
ConflictId |
Conflict ID |
String |
|
ModId |
Modification Id |
String |
|
Description |
Description of the product line. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
PrimaryPositionId |
ID of the primary position. |
String |
|
PrimaryProductId |
ID of the primary product. |
String |
|
ListOfAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
AdminProductLine_InternalProductIsPrimaryMVG |
Admin Product Line_Internal Product integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
Position_Id |
ID of the position. |
String |
|
PrimaryEmployeeId |
ID of the primary employee. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
WorkPhoneNumber |
Work phone number. |
String |
|
DivisionIntegrationId |
Division integration ID. |
String |
|
Division |
Division within the company. |
String |
|
ListOfAdminProductLine_InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
AdminProductLine_InternalProductIsPrimaryMVG |
Admin Product Line_Internal Product integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field. |
Integration Component |
|
Product |
Product name. |
String |
|
Part |
Part number. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
PrimaryOrganization |
The primary organization for the product. |
String |
|
VendorIntegrationId |
Integration ID of the vendor. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfAdminProductLine |
An instance of the integration object ListOfAdminProductLine. |
Integration Object |
|
AdminProductLine |
An integration component (XML tag) corresponding to the Admin Product Line business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. |
Integration Component |
|
Description |
Description of the product line. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
PrimaryPositionId |
ID of the primary position. |
String |
|
PrimaryProductId |
ID of the primary product. |
String |
|
ListOfAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
AdminProductLine_InternalProductIsPrimaryMVG |
Admin Product Line_Internal Product integration component instance that corresponds to a primary MVG and is denoted by the attribute IsPrimaryMVG set to Y. This attribute is a hidden integration component field and does not have a corresponding business component field. |
Integration Component |
|
Position |
Position, such as Administrator. |
String |
|
Position_Id |
ID of the position. |
String |
|
PrimaryEmployeeId |
ID of the primary employee. |
String |
|
ProductLineManager |
Product line manager. |
String |
|
WorkPhoneNumber |
Work phone number. |
String |
|
DivisionIntegrationId |
Division integration ID. |
String |
|
Division |
Division within the company. |
String |
|
ListOfAdminProductLine_InternalProduct |
Internal products associated with the product line. |
Integration Component |
|
Product |
Product name. |
String |
|
Part |
Part number. |
String |
|
IntegrationId |
Integration ID of the product record. |
String |
|
PrimaryOrganization |
The primary organization for the product. |
String |
|
VendorIntegrationId |
Integration ID of the vendor. |
String |
Message Description: SWI Product Line - QueryPage
For a description of the most important fields in the request 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 |
| 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 |
| 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 |
|---|---|---|
| ListofAdminProductLine | An instance of the integration object ListofAdminProductLine. | Integration Object |
|
AdminProductLine |
Integration Component (XML Tag) corresponding to the Admin Product Line Business component. You can create multiple instances of AdminProductLine under ListOfAdminProductLine to process different product lines at one time. | Integration Component |
| Description | Description of the product line. | String |
| IntegrationId | Integration ID of the product line. | String |
| Name | Name of the product line. | String |
| PrimaryPositionId | ID of the primary position. | String |
| PrimaryProductId | ID of the primary product. | String |
| ListofAdminProductLine_Position | Positions associated with the product line. | Integration Component |
| AdminProductLine_ PositionIsPrimaryMVG | An instance of the Admin Product Line_Position integration component that corresponds to aprimary MVG. It is denoted by the attribute IsPrimaryMVG and is set to Y. This attribute is a hidden integration component field, and it does not have a corresponding business component field. | Integration Component |
| Position | Position, such as Administrator. | String |
| PrimaryEmployeeId | ID of the primary employee. | String |
| ProductLineManager | Product line manager. | String |
| WorkPhoneNumber | Work phone number. | String |
| DivisionIntegrationId | Integration ID of the division. | String |
| Division | Division within the company. | String |
| ListOfAdminProductLine_InternalProduct | Internal products associated with the product line. | Integration Component |
| Product | Product name. | String |
| Part | Part number. | String |
| IntegrationId | Integration ID of the product record. | String |
| PrimaryOrganization | The primary organization for the product. | String |
| VendorIntegrationId | Integration ID of the vendor. | String |
Message Description: SWI Product Line - Delete
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBaseAdminProductLine |
An instance of the integration object ListOfBaseAdminProductLine. |
Integration Object |
|
Name |
Product line name. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBaseAdminProductLin |
An instance of the integration object ListOfBaseAdminProductLine. |
Integration Object |
|
ID |
ID of the product line. |
String |
|
Description |
Description of the product line. |
String |
|
Name |
Name of the product line. |
String |
|
PrimaryPositionId |
ID of the primary position. |
String |
|
PrimaryProductId |
ID of the primary product. |
String |