Item Structure Version 2
A set of component items arranged hierarchically to reflect the composition of a parent item, such as the structure of a car or a laptop computer.
Life Cycle Status: Active
QName: {http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}StructureService
Service WSDL URL: https://servername/fscmService/StructureServiceV2?WSDL
Logical Business Objects
-
SCM : Product Model : Item Structure
-
SCM : Product Model : Item Structure
-
SCM : Product Model : Item Structure
Relationships
The following table describes how this service data object is related to other service data objects or business object services.
| Relationship Type | Object or Service |
|---|---|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
|
|
Handles |
Operations
deleteStructure
A delete service operation for the Structure entity that adds the Structure to the delete group.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
itemNumber |
string |
An attribute value for the item name of the parent structure. |
|
organizationCode |
string |
An attribute value for the parent structure item organization. |
|
structureName |
string |
An attribute value for the structure represented by the Structure service data object to be deleted. |
|
deleteGroupName |
string |
An attribute value for the delete group which the structure will be added to. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
long |
The primary key (DeleteEntitySequenceId) output that is returned from the create deleteEnity operation. Errors that are generated will be displayed. |
deleteComponent
A delete service operation for the Structure Component entity that adds the Structure Component to the delete group.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
itemNumber |
string |
An attribute value for the item name of the parent structure. |
|
organizationCode |
string |
An attribute value for the parent structure item organization. |
|
structureName |
string |
An attribute value for the structure component represented by the Structure component service data object to be deleted. |
|
componentItemNumber |
string |
An attribute value for the item name of the structure component. |
|
componentItemSequenceNumber |
string |
An attribute value for the component item sequence number. The parameter value can be left null to select all components of the structure. |
|
deleteGroupName |
string |
An attribute value for the delete group which the structure component will be added to. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
long |
The primary key (DeleteEntitySequenceId) output that is returned from the create deleteEnity operation. Errors that are generated will be displayed. |
explodeStructure
The service operation is to explode the entity for a structure.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
itemNumber |
string |
An attribute value for the item name of the parent structure. |
|
organizationCode |
string |
An attribute value for the parent structure item organization. |
|
structureName |
string |
An attribute value for the structure represented by the Structure component service data object to be used in the explosion. |
|
explodeOption |
int |
An attribute value for options for the explode operation. The value include, 1 (All), 2 (Current), or 3 (Current and Future). The default option is 2 (Current). |
|
explosionDateTime |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The starting date that will be used for the structure explosion operation for date effective structures. |
|
fromUnitNumber |
string |
The starting unit number that will be used for the structure explosion operation for unit effective structures. |
|
fromSerialNumber |
string |
The starting serial number that will be used for the structure explosion operation for unit effective structures. |
|
implementationOnlyFlag |
boolean |
A flag that controls how unimplemented components are handled. If the the value is true, then the unimplemented components will be left out of explosion process. |
|
explosionType |
int |
An attribute value that represents the explosion type. The value include, 1 (Optional), 2 (Included), or 3 (Both). The default value is 3 (Both). |
|
explodeModelFlag |
boolean |
A flag that controls how Model Subassemblies are handled. If the the value is true, then the Model Subassemblies will be exploded. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned from the explosion operation is the exploeded structure. |
deletePack
A delete service operation for a single pack object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
parentItemNumber |
string |
The item name of the parent pack. |
|
itemNumber |
string |
The item name of the pack to be deleted. |
|
organizationCode |
string |
An attribute value for the parent pack item organization. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The pack component which was deleted. |
createStructureFromCopy
The service operation is to copy the entity for a structure.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
sourceItemNumber |
string |
An attribute value for the item name of the source item in the copy operation. |
|
sourceOrganizationCode |
string |
An attribute value for the item organization for the source item in the copy operation. |
|
targetItemNumber |
string |
An attribute value for the structure represented by the Structure service data object to be used as the source in the copy operation. |
|
targetOrganizationCode |
string |
An attribute value for the item name of the target item in the copy operation. |
|
sourceStructureName |
string |
An attribute value for the item organization for the target item in the copy operation. |
|
targetStructureName |
string |
An attribute value for the Structure service data object to be used as the target in the copy operation. |
|
levelsToCopy |
long |
An attribute value for the number levels in the structure to copy. The default is to copy up to 100 levels. |
|
sourceEffectivityDateTime |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
A source structure date that controls the way to effectivity is controlled within a date effective structure. The default value is the sysdate. |
|
sourceFromSerialNumber |
string |
The starting serial number that a component is effective in a source structure for serial number effective structures. |
|
sourceFromUnitNumber |
string |
The starting unit number that a component is effective in a source structure for unit number effective structures. |
|
targetFromSerialNumber |
string |
The starting serial number that a component is effective in a target structure for serial number effective structures. |
|
targetFromUnitNumber |
string |
The starting unit number that a component is effective in a target structure for unit number effective structures. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned from the copy operation is a structure service data object that represents the copied structure. |
createStructureFromCommon
The service operation is to create a common structure from a source structure.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
sourceItemNumber |
string |
An attribute value for the item name of the source item in the common operation. |
|
sourceOrganizationCode |
string |
An attribute value for the item organization for the source item in the common operation. |
|
targetItemNumber |
string |
An attribute value for the item name of the target item in the common operation. |
|
targetOrganizationCode |
string |
An attribute value for the item organization for the target item in the common operation. |
|
sourceStructureName |
string |
An attribute value for the structure represented by the Structure component service data object to be commoned. |
|
sourceEffectivityDateTime |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
A source structure date that controls the way to effectivity is controlled within a date and time of the effective structure. The default value is the sysdate. |
|
sourceFromSerialNumber |
string |
The starting serial number that a component is effective in a source structure for serial number effective structures. |
|
sourceFromUnitNumber |
string |
The starting unit number that a component is effective in a source structure for unit number effective structures. |
|
isEditableFlag |
boolean |
A flag that indicates that the common structure that is created is editable. The default value is false indicating the common structure created wil not be editable. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned from the common structure operation is a structure service data object for the common structure. |
componentWhereUsed
The service operation is to provide a list of structures where a component is used.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
componentItemNumber |
string |
An attribute value for the item name of the structure component. |
|
organizationCode |
string |
An attribute value for the parent structure item organization. |
|
effectiveDateTime |
{http://xmlns.oracle.com/adf/svc/types/}dateTime-Timestamp |
The date and time from which the component is effecitve for the where used operation. The default value is a string. |
|
fromSerialNumber |
string |
The starting effective serial number for the component used in the where used operation. The default value Null for the sting. |
|
toSerialNumber |
string |
The ending effective serial number for the component used in the where used operation. The default value Null for the sting. |
|
fromUnitNumber |
string |
The starting effective unit number for the component used in the where used operation. The default value Null for the sting. |
|
toUnitNumber |
string |
The ending effective unit number for the component used in the where used operation. The default value Null for the sting. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned from the where used operation is set of service data objects for the structures where the component is used. |
createStructure
An create service operation for a single item structure object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
structure |
Item Structure Version 2 |
An attribute value for the structure represented by the Structure service data object to be used in the create operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}StructureResult |
The output that is returned from the create operation is a structure service data object that has been created. |
updateStructure
An update service operation for a single item structure object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
structure |
Item Structure Version 2 |
An attribute value for the structure represented by the Structure service data object to be used in the update operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}StructureResult |
The output that is returned from the update operation is a structure service data object that has been updated. |
mergeStructure
An merge service operation for a single item structure object. If the entity exists it will be updated, otherwise a new entity will be created.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
structure |
Item Structure Version 2 |
An attribute value for the structure represented by the Structure service data object to be used in the merge operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}StructureResult |
The output that is returned from the merge operation consisting of the structure service data object that is merged. |
findStructure
A find service operation for the item structure entity.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
An attribute that represents the search criteria for the find operation. This parameter value is null initially, the user must add the attribute from the service data object. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
This parameter value is null and is not used currently. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned from the find operation is a list of objects that match the find criteria. |
createPack
An create service operation for a single pack object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
pack |
Pack |
An attribute value for the pack represented by the Pack service data object to be used in the create operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}PackResult |
The output that is returned from the create operation is a pack service data object that has been created. |
updatePack
An update service operation for a single pack object.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
pack |
Pack |
An attribute value for the pack represented by the Pack service data object to be used in the update operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}PackResult |
The output that is returned from the update operation is a pack service data object that has been created. |
mergePack
An merge service operation for a single pack object. If the entity exists it will be updated, otherwise a new entity will be created.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
pack |
Pack |
An attribute value for the pack represented by the Pack service data object to be used in the merge operation. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
{http://xmlns.oracle.com/apps/scm/productModel/items/structures/structureServiceV2/}PackResult |
An attribute value for the pack represented by the Pack service data object to be used in the merge operation. |
findPack
A find service operation for the pack entity.
Life Cycle Status: Active
Request Payload
| Element Name | Type | Description |
|---|---|---|
|
findCriteria |
{http://xmlns.oracle.com/adf/svc/types/}FindCriteria |
An attribute that represents the search criteria for the find operation. This parameter value is null initially, the user must add the attribute from the service data object. |
|
findControl |
{http://xmlns.oracle.com/adf/svc/types/}FindControl |
This parameter value is null and is not used currently. |
Response Payload
| Element Name | Type | Description |
|---|---|---|
|
result |
The output that is returned from the find operation is a list of objects that match the find criteria. |