For a list of operations associated with this REST API service, see the following table.
| Name | Description |
|---|---|
InsertOrUpdate |
Creates a new catalog or adds a category to existing catalog. |
Update |
Updates an existing catalog. |
QueryPage |
Queries for existing catalogs using the QueryPage method. |
QueryById |
Queries for an existing catalog using Row ID. |
|
QueryByExample |
Queries for existing catalogs using the QueryPage method. |
|
Delete |
Deletes a catalog. |
Message Description: SWI Catalog Admin - InsertOrUpdate
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Name of the catalog. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Category name. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Category name. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
Message Description: SWI Catalog Admin - Update
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Category name. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration Component (XML Tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Category name. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
Message Description: SWI Catalog Admin - 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 |
|
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 |
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Category name. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
Message Description: SWI Catalog Admin - 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 literature. |
String |
|
OutputIntObjectName |
Name of the output integration object. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Name of category. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
Message Description: SWI Catalog Admin - QueryByExample
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object ListOfBase Catalog Admin. |
Integration Object |
|
Product Catalog |
Integration component corresponding to the Product Catalog business component. |
Integration Component |
|
Name |
Name of the catalog to be queried. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |
|
Catalog Type |
Type of catalog. |
String |
|
Effective Start Date |
Start date for a catalog. |
String |
|
Effective End Date |
End date for a catalog. |
String |
|
ListOfCatalog Category Admin |
List of categories within a catalog. |
Integration Component |
|
ListofAdminProductLine_Position |
Positions associated with the product line. |
Integration Component |
|
Name |
Category name. |
String |
|
ListOfInternal Product |
Internal products associated with the catalog. |
Integration Component |
|
Name |
Product name. |
String |
|
ListOfCatalog Category Translation |
Translation for the catalog categories. |
Integration Component |
|
Language Code |
Language code. |
String |
|
ListOfProduct Catalog Translation |
Translation for the catalog. |
Integration Component |
|
Language Code |
Language code. |
String |
Message Description: SWI Catalog Admin - Delete
For a description of the most important fields in the request section, see the following table.
| Node | Description | Type |
|---|---|---|
|
SiebelMessage |
The input or the output integration object instance. |
Integration Object |
|
Name |
Catalog name. |
String |
For a description of the most important fields in the response section, see the following table.
| Node | Description | Type |
|---|---|---|
|
ListOfBase Catalog Admin |
An instance of the integration object Base Catalog Admin. |
Integration Object |
|
Product Catalog |
An integration component (XML tag) corresponding to the Product Catalog business component. You can create multiple instances of Product Catalog under ListOfBase Catalog Admin to process different product catalogs at one time. |
Integration Component |
|
Name |
Catalog name. |
String |