Operations You Can Use with Web Services for Configured Items
Use operations with the ConfiguredItemService web service to create, read, update, or delete a configured item.
|
Operation |
Value |
|---|---|
|
findCtoSalesStructure |
Get the set of options, option classes, and transaction attributes you user selects at runtime. |
|
findCtoItemStructure |
Get the entire structure of the configured item that your user selects at runtime. It includes child configured items, options, required components, phantoms, substitutions and transaction attributes. |
|
refreshConfigStructure |
Refresh the item structure in the explosion repository. |
|
deleteConfigStrucure |
Delete the item structure from the explosion repository. |
findCtoSalesStructure and findCtoItemStructure Operations
Get Sales Structure
Here's the payload that the findCtoSalesStructure operation returns for the VIK12-100 configured item. Learn about this item. For details, see Overview of Using Web Services with Configure-to-Order.
|
LINE_ID |
SUB_ITEM_TYPE |
ITEM_NUMBER |
PARENT_ LINE_ID |
CONFIG ITEM NUMBER |
QTY |
UOM |
|---|---|---|---|---|---|---|
|
1 |
ATO |
VIK12 |
1 |
VIK12-100 |
1 |
EA |
|
2 |
ATO |
BRN1 |
1 |
BRN1-11 |
1 |
EA |
|
3 |
OPTION CLASS |
FTOC |
2 |
FTOC |
1 |
EA |
|
4 |
RES |
GAS |
3 |
GAS |
1 |
EA |
|
5 |
ATO |
BSOC |
2 |
BSOC-2 |
1 |
EA |
|
6 |
OPTION CLASS |
COM |
5 |
COM |
1 |
EA |
|
7 |
RES |
COMLG |
6 |
COMLG |
1 |
EA |
|
8 |
RES |
GRD |
6 |
GRD |
1 |
EA |
The payload includes each of the child assemble-to-order items. Assume BRN-11, BSOC-2, and OVOC-30 are the child configured items.
Get Item Structure
Here's the payload that the findCtoItemStructure operation returns for the VIK12-100 configured item.
|
LINE_ID |
SUB_ITEM_TYPE |
ITEM_NUMBER |
INVENTORY_ITEM_ID |
PARENT_LINE_ID |
CONFIG ITEM_NUMBER |
QTY |
UOM |
WIP_SUPPLY_TYPE |
RootPhantomItemId |
|---|---|---|---|---|---|---|---|---|---|
|
1 |
ATO |
VIK12 |
100 |
1 |
VIK12-100 |
1 |
EA |
- |
- |
|
2 |
ATO |
BRN1 |
101 |
1 |
BRN1-11 |
1 |
EA |
- |
- |
|
3 |
OPTION CLASS |
FTOC |
102 |
2 |
FTOC |
1 |
EA |
- |
- |
|
4 |
STD |
GAS |
103 |
3 |
GAS |
1 |
EA |
- |
- |
|
5 |
ATO |
BSOC |
200 |
2 |
BSOC-2 |
1 |
EA |
- |
- |
|
6 |
OPTION CLASS |
COM |
201 |
5 |
COM |
1 |
EA |
- |
- |
|
7 |
RES |
COMLG |
202 |
6 |
COMLG |
1 |
EA |
Phantom |
- |
|
8 |
RES |
COM-BRN |
203 |
7 |
COM-BRN |
1 |
EA |
Phantom |
202 |
|
9 |
RES |
COM-BRN-BS |
204 |
8 |
COM-BRN-BS |
1 |
EA |
- |
202 |
|
10 |
RES |
COM-BRN-VAL |
205 |
8 |
COM-BRN-VAL |
1 |
EA |
- |
202 |
|
11 |
RES |
COM-BCAP |
206 |
7 |
COM-BCAP |
1 |
EA |
- |
202 |
|
12 |
RES |
GRD |
207 |
6 |
GRD |
1 |
EA |
- |
- |
|
13 |
ATO |
OVOC |
300 |
1 |
OVOC-30 |
1 |
EA |
- |
- |
|
14 |
OPTION CLASS |
OVTY |
301 |
13 |
OVTY |
1 |
EA |
- |
- |
|
15 |
RES |
GASC |
302 |
14 |
GASC |
1 |
EA |
- |
- |
|
16 |
OPTION CLASS |
WRM |
303 |
13 |
WRM |
1 |
EA |
- |
- |
|
17 |
RES |
WRMGASC |
304 |
16 |
WRMGASC |
1 |
EA |
- |
- |
|
18 |
OPTION CLASS |
FINOC |
104 |
1 |
FINOC |
1 |
EA |
- |
- |
|
19 |
RES |
FINSS |
105 |
18 |
FINSS |
1 |
EA |
- |
- |
|
20 |
RES |
STVU |
106 |
1 |
STVU |
1 |
EA |
- |
- |
|
21 |
RES |
CLK |
107 |
1 |
CLK |
1 |
EA |
Phantom |
- |
|
22 |
RES |
CLSS |
108 |
21 |
CLSS |
1 |
EA |
- |
107 |
|
23 |
RES |
CL-CTRL |
109 |
21 |
CL-CTRL |
1 |
EA |
- |
107 |
findCtoItemStructure includes details that findCtoSalesStructure doesn't include.
-
The payload includes the required items STVU and CLK.
-
PARENT_LINE_ ID identifies the parent of the item. For example, PARENT_LINE_ ID for BRN1 is 1. BRN1 is a child in VIK12. The LINE_ID for VIK12 is 1.
-
WIP_SUPPLY_TYPE indicates whether the item is a phantom.
-
COMLG and CLK are phantom items, so the detail includes their subassemblies.
-
RootPhantomItemId identifies the phantom that contains the item. For example, the RootPhantomItemId for CM-BRN is 202. CM-BRN is an item in phantom COMLG. The INVENTORY_ITEM_ ID for COMLG is 202.
Transaction Attributes
The web service also returns transaction attributes when it returns the item.
|
LINE_ID |
ATTRIBUTE_NAME |
CHARACTER_ATTRIBUTE_VALUE |
NUMBER_AT TRIBUTE_VALUE |
TIMESTAMP_ ATTRIBUTE_VALUE |
|---|---|---|---|---|
|
7 |
FINISH |
Black |
- |
- |
refreshConfigStructure and deleteConfigStrucure Operations
Configure-to-order saves structure details for the configured item in the explosion repository when the flow requests the structure. You use the refreshConfigStructure operation to refresh this data. Refreshing helps to reduce the amount of data that findCtoItemStructure returns and improves performance.
Details for the configured item are already available in the repository, so it isn't necessary to bring data into the repository as part of findCtoItemStructure.
-
Use refreshConfigStructure before you use findCtoItemStructure.
-
Use the same set of parameters you use with findCtoItemStructure.
-
Set the RefreshStructure attribute in the first row of your payload. Set it to.
-
true. Refresh data that already exists in the repository before getting it.
-
false. Save only the missing structure details in the repository. Don't refresh data that already exists in the repository. The default value is false.
-
Use deleteConfigStrucure to delete structure details of the configured item from the repository.
Parameters You Use with Operations
Here are the parameters you can use with the operations to identify the item you want to find, refresh or delete. Use them with operations.
-
findCtoSalesStructure
-
findCtoItemStructure
-
refreshConfigStructure
-
deleteConfigStrucure
You must use at least one of parameter. If you don't, the web service will display an error.
|
Attribute |
Type |
Description |
|---|---|---|
|
ConfigItemId |
Long |
Value that identifies the configured item. |
|
ConfigItemNumber |
String |
Name of the configured item. |
|
BaseModelId |
Long |
Value that identifies the assemble-to-order model. |
|
BaseModelItemNumber |
String |
Name of the assemble-to-order model. |
|
CreationDateFrom |
Date |
Date when the flow started to create the configured item. |
|
CreationDateTo |
Date |
Date when the flow finished creating the configured item. |
For example, to refresh data for the VIK12-100, set ConfigItemNumber to VIK12-100.