Web Services for Publishing

This appendix covers the following topics:

• Oracle Product Hub Web Services Overview
• Value Set Web Service
• Attribute Group Web Service
• Item Catalog Category Web Service
• Item Web Service
• Controlling the Output Payload
• Error Reporting

Oracle Product Hub Web Services Overview

Users can publish item catalog categories, attribute groups, value sets, or items and extract more information about these entities by invoking entity specific Web Services for Oracle Product Hub. The following Web Services are available to Product Hub users:

• Item catalog category web service

• Attribute group web service

• Value set web service

• Item web service

The figure below shows a sample implementation that consumes one of these Web Services.

System Flow and Interaction Diagram

Related Topics

Publishing Overview, Oracle Product Hub User's Guide

Item Catalog Category Web Service

Attribute Group Web Service

Value Set Web Service

Item Web Service

Value Set Web Service

The value set Web Service includes the getValueSetDetails method, which returns the details of the value set according to the parameters requested in the output. Users can invoke the method on both value set versions and non-version value sets.

Important: Before using Publication Web Services, you must complete some manual post-installation steps. Complete the steps documented in My Oracle Support ID 1336146.1. This My Oracle Support ID also includes troubleshooting tips.

Method: getValueSetDetails

This Web Service method provides an interface to extract the information about the value set and/or its hierarchy based on input.

Modes

You can invoke the getValueSetDetails method using two modes:

Batch Mode

• Retrieves the details of the value set(s) published as part of a batch from the PIM Publication user interface.

• Use this mode when you can directly provide the batch ID to use the value set services. The parameters provided while creating the batch take precedence over the values provided for the parameters below while invoking the service.

List Mode

• Passes a list of value set identifiers directly as input to the getValueSetDetails method.

• Optionally provides any number of value set IDs for invoking the services.

While invoking the value set services in either mode, provide the following WS-Security and Parameter inputs:

WS-Security

Parameter Name	Type	Optional	Description
User Name	String	NO	EBS “Applications User name”
Password	String	NO	Password for EBS “Applications User”

Parameters

Parameter Name	Type	Optional	Description
BatchId	Integer	No (batch mode) Yes (non-batch mode)	The identifier of the Batch that was published from the PIM UI.
ValueSetId	Integer	Yes (batch mode) No (non-batch mode)	Value set ID for which the details need to be extracted/published. In Batch Mode, the Value Set ID is derived for the selected value set, so there is no need to provide an ID. In List Mode: When publishing to external systems, you must provide the ValueSetId. When publishing to other Oracle Product Hub systems, you must provide either the ValueSetId or the ValueSetName.
ValueSetName	String	Yes Note: This parameter is not considered when publishing to external systems.	The name of the value set to publish to other Oracle Product Hub systems. In Batch Mode, the value set name is derived for the selected value set, so there is no need to provide a name. In List Mode, when publishing to other Oracle Product Hub systems, you must provide either the ValueSetId or the ValueSetName.
VersionSeqId	Integer	Yes	Version for which the service is needed. If left blank, the default is the current effective version.
ChildValueSets	String	No	Flag that indicates whether to publish child value sets associated with the selected value sets.
Sync Additional Information: This appears as the "Publish to PIM Systems Only" checkbox in the batch publishing flow.	String	No (batch mode), No (non-batch mode)	Flag to indicate whether to publish to external systems or other Oracle Product Hub systems. A value of Y indicates publishing to Oracle Product Hub systems. A value of N indicates publishing to external systems.
TriggerImport	String	No Note: This parameter is not considered when publishing to external systems.	Flag to control whether to launch the 'EGO Import Metadata' concurrent program in the target Oracle Product Hub system or not. If it is set to 'N', the metadata interface tables in the target OPH systems are loaded with the data from the source OPH system. Users must manually launch this concurrent program to import the data in the interface tables into the production tables. If it is set to 'Y', this concurrent program is automatically launched in the target OPH system, which then imports the data from the interface tables into the production tables. Default Value: N
ReturnPayload	Boolean	Yes Default: True	Flag to control whether the output payload includes the details of the ICC(s)

Multi Selection Parameters

Parameter Name	Type	Optional	Description
LanguageCode	String	Yes (batch mode) Yes (non-batch mode) Note: This parameter is not considered when publishing to Oracle Product Hub systems.	The language code in which to return the output. For example: US (for American English). Default: Return output in all installed languages. Note: Repeat this parameter multiple times to return output in more than one language. When publishing to external systems: The language code in which to return the output, for example, US (for American English). Default: Return output in all installed languages. Note: Repeat this parameter multiple times to return output in more than one language. When publishing to Oracle Product Hub systems: The value set translatable column values are published in all of the installed languages common between the source and target OPH systems.
LanguageName	String	Yes (batch mode), Yes (non-batch mode) Note: This parameter is not considered when publishing to Oracle Product Hub systems.	When publishing to external systems: The language name in which to return the output, for example, English. When publishing to Oracle Product Hub systems: Value set translatable column values are published in all of the installed languages common between the source and target OPH systems.
SystemCode	String	Yes (batch mode) No (non-batch mode) Note: This parameter is not considered when publishing to external systems.	The system code for a target OPH system to which you plan to publish the ICC(s). Default behavior: at least one target OPH system must be selected/provided. Note: Repeat this parameter multiple times when publishing to multiple systems.
SystemName	String	Yes (batch mode) No (non-batch mode) Note: This parameter is not considered when publishing to external systems.	The system name for a target OPH system to which you plan to publish the ICC(s). Default behavior: at least one target OPH system must be selected/provided. Note: Repeat this parameter multiple times when publishing to multiple systems.

FND Security Parameters

Parameter Name	Type	Optional	Description
RESPONSIBILITY_NAME	String	No (batch mode) No (non-batch mode)	Provide the Responsibility name for the user. For example: EGO_DEVELOPMENT_MANAGER Note: In batch mode (using the UI flow), it is derived from the EBS Login.
RESPONSIBILITY_APPL_NAME	String	No (batch mode) No (non-batch mode)	Application name for the above responsibility. For example: EGO Note: In batch mode (using the UI flow), it is derived from the EBS Login.
SECURITY_GROUP_NAME	String	Yes (batch mode) No (non-batch mode)	Security group name.
NLS_LANGUAGE	String	Yes (batch mode) No (non-batch mode)	The current session language to use for the Web Service invocation.

Output

The output payload includes value set details based on the configurable parameters selected by the user.

Payload when publishing to external systems:

• ListOfValueSets

  • Valueset

    • ValueSetId - Value set identifier.

    • ValueSetName - Name.

    • Description - Description.

    • DataType - Data type of the value set.

    • MaximumSize - Maximum size limit.

    • ValidationType - Validation type of the value set.

    • MinimumValue - Minimum value (applicable for only Number, Date, and Date Time data types).

    • MaximumValue - Maximum value (applicable for only Number, Date, and Date Time data types).

    • ParentValueSetName - Parent value set name if this is a child value set.

    • ValuesetValue - List of values for this value set (only for non-version value sets).

    • TranslatableAttributes

    • ValuesetVersion - List of versions for a value set with versions.

      • VersionSeqId - Sequence ID of the version.

      • Description - Description.

      • StartActiveDate - Effective start date.

      • EndActiveDate - Effective end date.

      • VersionedVSValue - List of values for this version.

    • TableInfo - Validation information for a table type value set.

      • TableName - Database table name.

      • WhereClause - Where clause.

      • ValueColumn - Value column.

      • IDColumn - ID Column.

      • MeaningColumn - Meaning column.

  • Status - Status information

    • Error - Error information

      • Code - Error code.

      • Message - Error message.

  • AdditionalInfo - Additional info section when returnPayload input flag is set to false.

    • SessionId - Session ID for invocation.

    • EntityCount - Output entity count.

Payload when publishing to Oracle Product Hub systems:

• Status - Status information

  • Error - Error information

    • Code

    • Message

    • Language Code

    • System Code

  • Warning - Warning information

    • Code

    • Message

    • Language Code

    • System Code

  • AdditionalInfo – Additional Info Section

    • SessionId

    • EntityCount

Related Topics

Oracle Product Hub Web Services Overview

Publishing Overview, Oracle Product Hub User's Guide

Defining Source Systems

Publishing Item Catalog Categories

Publishing Attribute Groups

Publishing Value Sets

Publishing Items and Structures, Oracle Product Hub User's Guide

Viewing the Publishing History, Oracle Product Hub User's Guide

Controlling the Output Payload

Error Reporting

Attribute Group Web Service

The attribute group Web Service includes the getAGDetails method, which publishes the details of an attribute group and its associated entities to target Oracle Product Hub (OPH) systems based on input to these systems.

Important: Before using Publication Web Services, you must complete some manual post-installation steps. Complete the steps documented in My Oracle Support ID 1336146.1. This My Oracle Support ID also includes troubleshooting tips.

Method: getAGDetails

The getAGDetails method provides an interface to extract information about attribute groups and their associated entities ( which include business entities, attributes, and value sets/child value sets associated to the attributes) based on input and then publish them to target OPH systems.

Modes

You can invoke the getAGDetails method using two modes:

Batch Mode

• Retrieves the details of the attribute group(s) published as part of a batch from the PIM Publication user interface and publishes them to target OPH systems.

• Use this mode when you can directly provide the batch ID to use the attribute group services. The parameters provided while creating the batch take precedence over the values provided for the parameters below while invoking the service.

List Mode

• Passes a list of attribute group identifiers directly as input to the getAGDetails method.

• Optionally provides any number of attribute group IDs for invoking the services.

While invoking the attribute group services in either mode, provide the following WS-Security and Parameter inputs:

WS-Security

Parameter Name	Type	Optional	Description
User Name	String	NO	EBS “Applications User name”
Password	String	NO	Password for EBS “Applications User”

Parameters

Parameter Name	Type	Optional	Description
BatchId	Integer	No (batch mode) Yes (non-batch mode)	The identifier of the Batch that was published from the PIM UI.
AGId	Integer	Yes (batch mode) No (non-batch mode)	Attribute Group ID for which the details need to be published. Note: In Batch Mode, there is no need to provide the AGId. It is derived for the selected attribute group(s) in the batch. In List Mode, you must provide either the AGId or the AGName.
Agname	String	Yes (batch mode), No (non-batch mode)	The name of the attribute group to be published. Note: In Batch Mode, there is no need to provide the AGname. It is derived for the selected attribute group(s) in the batch. In List Mode, you must provide either the AGId or the AGName.
Valuesets	String	Yes (batch mode), No (non-batch mode) Default Value: Y	Flag to control whether to publish the value sets associated with the user defined attributes to target OPH systems.
ChildValuesets	String	Yes (batch mode), No (non-batch mode) Default Value: Y	Flag to control whether to publish the child value sets associated with the user defined attributes to target OPH systems.
Sync (In Batch flow - Publish to PIM Systems Only checkbox)	String	Yes (batch mode), No (non-batch mode) Default Value: Y	Flag to indicate whether to publish to external systems or OPH systems. Value Y indicates publishing to OPH systems. The attribute group Webservice supports publishing to OPH systems only.
Auto Import	String	Yes (batch mode), No (non-batch mode) Default Value: N	Flag to control whether to launch the 'EGO Import Metadata' concurrent program in the target OPH system or not. If it is set to 'N', the metadata interface tables in the target OPH systems are loaded with the data from the source OPH system. Users must manually launch this concurrent program to import the data in the interface tables into the production tables. If it is set to 'Y', this concurrent program is automatically launched in the target OPH system. The program imports the data from the interface tables into the production tables.
Return Payload	String	No (non-batch mode) Default Value: N Note: This parameter is honored only in List mode.	Flag to control whether user wants to display the concurrent program errors and warnings that occur in the target OPH systems, as well as any additional information provided about the attribute groups.

Multi Selection Parameters

Parameter Name	Type	Optional	Description
LanguageCode	String	Yes (batch mode), Yes (non-batch mode) This parameter is not considered when publishing to OPH systems.	When publishing to OPH systems, attribute group translatable column values are published in all the installed languages common between the source and target OPH systems.
LanguageName	String	Yes (batch mode), Yes (non-batch mode) This parameter is not considered when publishing to OPH systems.	When publishing to OPH systems, attribute group translatable column values are published in all of the installed languages common between the source and target OPH systems.
SystemCode	String	Yes (batch mode) No (non-batch mode) Default behavior: You must select at least one target OPH system. Note: Repeat this parameter multiple times to publish to multiple systems.	The system code for a target OPH system.
SystemName	String	Yes (batch mode), No (non-batch mode) Default behavior: Select at least one target OPH system. Note: Repeat this parameter multiple times to publish to multiple systems.	The system name for a target OPH system.

FND Security Parameters

Parameter Name	Type	Optional	Description
RESPONSIBILITY_NAME	String	No (batch mode) No (non-batch mode)	Provide the Responsibility name for the user. For example: EGO_DEVELOPMENT_MANAGER. Note: In batch mode (UI flow), the responsibility name is derived from the EBS Login.
RESPONSIBILITY_APPL_NAME	String	No (batch mode), No (non-batch mode)	Application name for the above responsibility. For example: EGO Note: In batch mode (UI flow), the application name is derived from the EBS Login.
SECURITY_GROUP_NAME	String	Yes (batch mode) No (non-batch mode)	Security group name.
NLS_LANGUAGE	String	Yes (batch mode) No (non-batch mode)	The current session language to use for the Web Service invocation.

Output

The output payload includes details based on the configurable parameters selected by the user.

Payload when publishing to Oracle Product Hub systems:

• Status - Status information

  • Error - Error information

    • Code

    • Message

    • Language Code

    • System Code

  • Warning - Warning information

    • Code

    • Message

    • Language Code

    • System Code

  • AdditionalInfo – Additional Info Section

    • SessionId

    • EntityCount

Related Topics

Oracle Product Hub Web Services Overview

Publishing Overview, Oracle Product Hub User's Guide

Defining Source Systems

Publishing Value Sets

Publishing Attribute Groups

Publishing Item Catalog Categories

Publishing Items and Structures, Oracle Product Hub User's Guide

Viewing the Publishing History, Oracle Product Hub User's Guide

Controlling the Output Payload

Error Reporting

Item Catalog Category Web Service

The item catalog category (ICC) Web Service includes the getICCDetails method, which returns the details of the ICC according to the parameters requested in the output. Users can invoke the method on both ICC versions and non-version ICCs. It can also be used to publish an ICC and its associated entities to other Oracle Product Hub systems.

Important: Before using Publication Web Services, you must complete some manual post-installation steps. Complete the steps documented in My Oracle Support ID 1336146.1. This My Oracle Support ID also includes troubleshooting tips.

Method: getICCDetails

This Web Service method provides an interface to extract the information about the ICC and/or its hierarchy based on input. It can also be used to publish this data to other Oracle Product Hub systems.

Modes

You can invoke the getICCDetails method using two modes:

Batch Mode

• Retrieves the details of the ICC(s) published as part of a batch from the PIM Publication user interface.

• Use this mode when you can directly provide the batch ID to use the ICC services. The parameters provided while creating the batch take precedence over the values provided for the parameters below while invoking the service.

List Mode

• Passes a list of ICC identifiers directly as input to the getICCDetails method.

• Optionally provides any number of ICC IDs for invoking the services.

While invoking the ICC services in either mode, provide the following WS-Security and Parameter inputs:

WS-Security

Parameter Name	Type	Optional	Description
User Name	String	NO	EBS “Applications User name”
Password	String	NO	Password for EBS “Applications User”

Parameters

Parameter Name	Type	Optional	Description
BatchId	Integer	No (batch mode) Yes (non-batch mode)	The identifier of the Batch that was published from the PIM UI.
ICCId	Integer	Yes (batch mode) No (non-batch mode)	The identifier of the ICC to be extracted/published. Note: In Batch Mode, the ICCId is derived from the selected ICC. In List Mode: When publishing to external systems, you must provide the ICCId. When publishing to Oracle Product Hub systems, you must provide either the ICCId or the ICCName.
ICCName	String	Yes Note: This parameter is not considered while publishing to external systems.	The name of the ICC to be published to other Oracle Product Hub systems. In Batch Mode, the ICCName is derived from the selected ICC. In List Mode, provide either the ICCId or the ICCName.
VersionSequence	Integer	Yes (batch mode) No (non-batch mode)	Version for which the service is needed. If left blank, the default is the current effective version.
UserDefAttrGrps	Boolean	Yes	Flag to control whether to include the user defined attribute groups associated with the ICC(s) in the output payload or when publishing to Oracle Product Hub systems. Default Value : True
Valuesets	String	Yes Note: This parameter is not considered when publishing to external systems.	Flag to control whether to publish value sets associated with user defined attributes when publishing to Oracle Product Hub systems. Default Value : True
ICCVersions	String	Yes Note: This parameter is not considered when publishing to other Oracle Product Hub systems.	Flag that controls whether the version information for the ICC(s) is included in the output payload. Default Value: True
TransAttrs	String	Yes Note: This parameter is not considered when publishing to other Oracle Product Hub systems.	Flag to control whether the transaction attributes for the ICC(s) are included in the output payload. Default Value: True
ICCPages	String	Yes Note: This parameter is not considered when publishing to external systems.	Flag that controls whether to publish pages associated with ICCs to Oracle Product Hub systems. Default Value: True
ICCFunctions	String	Yes Note: This parameter is not considered when publishing to external systems.	Flag that controls whether to publish functions associated with ICCs to Oracle Product Hub systems. Default Value: True
ICCStructure	String	Yes Note: This parameter is not considered when publishing to other Oracle Product Hub systems.	Flag to control whether the structures for ICC(s) are included in the output payload. Default Value: True
ParentICCs	String	Yes	Flag to control whether the parent hierarchy for the ICC(s) is included in the output payload or published to Oracle Product Hub systems. Default Value: True Note: This parameter is honored only during “List” mode calls to the getICCDetails method.
ChildICCs	String	Yes	Flag to control whether the child hierarchy for ICC(s) is included in the output payload or published to Oracle Product Hub systems. Default Value: True Note: This parameter is honored only during a “List” mode call to the getICCDetails method.
Sync Note: This appears as the "Publish to PIM Systems Only" checkbox in the batch publishing flow.	String	No (batch mode) No (non-batch mode)	Flag to indicate whether to publish to external systems or other Oracle Product Hub systems. A value of Y indicates publishing to Oracle Product Hub systems. a value of N indicates publishing to external systems.
Auto Import	String	Yes Note: This parameter is not considered when publishing to external systems.	Flag to control whether to launch the 'EGO Import Metadata' concurrent program in the target Oracle Product Hub system or not. If it is set to 'N', the metadata interface tables in the target OPH systems are loaded with the data from the source OPH system. Users must manually launch this concurrent program to import the data in the interface tables into the production tables. If it is set to 'Y', this concurrent program is automatically launched in the target OPH system, which then imports the data from the interface tables into the production tables. Default Value: N
ReturnPayload	String	Yes Note: This parameter is honored only in List mode.	Publishing to external systems: Flag to control whether the output payload includes the ICC(s) details. Publishing to other Oracle Product Hub systems: Flag to control whether to display concurrent program errors and warnings occurring in the target OPH systems as well as any additional ICC information provided for publishing. Default Value: True

Multi Selection Parameters

Parameter Name	Type	Optional	Description
LanguageCode	String	Yes (batch mode) Yes (non-batch mode) Note: This parameter is not considered when publishing to Oracle Product Hub systems.	When publishing to exteral systems: The language code in which to return the output, for example, US (for American English). Default: Return output in all installed languages. Note: Repeat this parameter multiple times to return output in more than one language. When publishing to Oracle Product Hub systems: When publishing to OPH systems, the attribute group translatable column values are published in all of the installed languages common between the source and target OPH systems.
LanguageName	String	Yes (batch mode), Yes (non-batch mode) Note: This parameter is not considered when publishing to Oracle Product Hub systems.	When publishing to external systems: The language name in which to return the output, for example, English. When publishing to Oracle Product Hub systems: When publishing to OPH systems, attribute group translatable column values are published in all of the installed languages common between the source and target OPH systems.
SystemCode	String	Yes (batch mode) No (non-batch mode) Note: This parameter is not considered when publishing to external systems.	The system code for a target OPH system to which you plan to publish the ICC(s) . Default behavior: at least one target OPH system must be selected/provided. Note: Repeat this parameter multiple times when publishing to multiple systems.
SystemName	String	Yes (batch mode) No (non-batch mode) Note: This parameter is not considered when publishing to external systems.	The system name for the target OPH system to which you plan to publish the ICC(s) . Default behavior: at least one target OPH system must be selected/provided. Note: Repeat this parameter multiple times when publishing to multiple systems.

FND Security Parameters

Parameter Name	Type	Optional	Description
RESPONSIBILITY_NAME	String	No (batch mode) No (non-batch mode)	Provide the Responsibility name for the user. For example: EGO_DEVELOPMENT_MANAGER Note: In batch mode (using the UI flow), it is derived from the EBS Login.
RESPONSIBILITY_APPL_NAME	String	No (batch mode) No (non-batch mode)	Application name for the above responsibility. For example: EGO Note: In batch mode (using the UI flow), it is derived from the EBS Login.
SECURITY_GROUP_NAME	String	Yes (batch mode) No (non-batch mode)	Security group name.
NLS_LANGUAGE	String	Yes (batch mode) No (non-batch mode)	The current session language to use for the Web Service invocation.

Output

The output payload includes details based on the configurable parameters selected by the user.

Payload when publishing to external systems:

• ListOfICCs

  • ItemCatalogCategory

    • ItemCatalogGroupId - The ICC ID for which the details have been produced.

    • EnabledFlag - Flag indicating whether ICC is enabled.

    • InactiveDate - Inactive Date

    • ItemCreationAllowedFlag - Flag indicating ICC is available for item creation.

    • ParentCatalogGroupId - Parent ICC ID for the given ICC ID.

    • ParentCatalogGroupName - Parent ICC name for the given ICC ID.

    • CategoryName - The concatenated name of the category formed from all segments.

    • Segment1..20 - Segments containing the ICC Name.

    • TranslatableAttributes

      • Language

      • Description

    • ICCVersion

      • TransactionAttribute - Transaction attributes list and metadata for the ICC version.

      • ICCStructure - Structure associated with the ICC version and its metadata.

    • UserDefAttrGrpAssociation - List of user defined attribute groups and their metadata associated to the ICC.

      • UserDefinedAttrGroup

        • TranslatableAttributes

        • UserDefAttrGrpBusEntity

        • UserDefinedAttribute - List of user defined attributes and their metadata.

          • TranslatableAttributes

          • Valueset

  • Status - Status information

    • Error - Error information

      • Code

      • Message

  • AdditionalInfo - Additional Info Section

    • SessionId

    • EntityCount

Payload when publishing to Oracle Product Hub systems:

• Status - Status information

  • Error - Error information

    • Code

    • Message

    • Language Code

    • System Code

  • Warning - Warning information

    • Code

    • Message

    • Language Code

    • System Code

  • AdditionalInfo – Additional Info Section

    • SessionId

    • EntityCount

Related Topics

Publishing Overview, Oracle Product Hub User's Guide

Oracle Product Hub Web Services Overview

Defining Source Systems

Publishing Item Catalog Categories

Controlling the Output Payload

Error Reporting

Item Web Service

The item Web Service includes the getItemDetails and getStructureDetails methods, which return the details of the item according to the parameters requested in the output.

Important: Before using Publication Web Services, you must complete some manual post-installation steps. Complete the steps documented in My Oracle Support ID 1336146.1. This My Oracle Support ID also includes troubleshooting tips.

Method: getItemDetails

This Web Service method provides an interface to extract the information about the item and/or its hierarchy based on input.

Modes

You can invoke the getItemDetails method using three modes:

Batch Mode

• Retrieves the details of the item(s) published as part of a batch from the PIM Publication user interface.

• Use this mode when you can directly provide the batch ID to use the item services. The parameters provided while creating the batch take precedence over the values provided for the parameters below while invoking the service.

Single Item Mode

• Use to pass item identifiers for a single item to the getItemDetails method.

• Use the basic input identifiers (InventoryItemId or InventoryItemName) and (OrganizationId or OrganizationCode) and (RevisionId or Revision or RevisionDate) in this mode.

List of Items Mode

• Apart from the single item mode, this passes a list of item identifiers directly as input to the getItemDetails method.

• Optionally provides any number of item identifiers for invoking the services.

• Use the list of basic input identifiers (InventoryItemId or InventoryItemName) and (OrganizationId or OrganizationCode) and (RevisionId or Revision or RevisionDate) in this mode.

While invoking the item services in either mode, provide the following WS-Security and Parameter inputs:

WS-Security

Parameter Name	Type	Optional	Description
User Name	String	NO	EBS “Applications User name”
Password	String	NO	Password for EBS “Applications User”

Parameters

itemQueryParameters
Parameter Name	Type	Optional	Description
BatchId	Integer	No (batch mode) Yes (list mode) Yes (single item mode)	The batch identifier that was published from the PIM user interface.
InventoryItemId	Integer	Yes (batch mode) Yes (list mode) No (single item mode)	Item identifier for which to extract the details.
OrganizationId	Integer	Yes (batch mode) Yes (list mode) No (single item mode)	Organization identifier to which the publishing item belongs.
OrganizationCode	String	Yes (batch mode) Yes (list mode) No (single item mode)	Organization code to which the publishing item belongs.
RevisionId	Integer	Yes (batch mode) Yes (list mode) No (single item mode)	Revision ID of the publishing item.
Revision	String	Yes (batch mode) Yes (list mode) No (single item mode)	Revision code of the publishing item.
RevisionDate	Date	Yes (batch mode) No (list mode) No (single item mode)	Revision date of the publishing item. If the structure name is provided, this date is considered for explosion of the structure in list or single item mode.
StructureName	String	Yes (batch mode) No (list mode) No (single item mode)	Structure name of the publishing item. All components of this structure are published along with the publishing item in list and single item mode. Note: For the primary structure, provide the value as "Primary".
InventoryItemName
Segment1 through Segment19	String	Yes (batch mode) Yes (List mode) Single item mode: Yes – If InventoryItemId is provided. No – If InventoryItemId is not provided.	The name of each individual segment that comprises the Publishing item name. Note: The characteristics for all 19 segments are the same.
BomExploderParameters
LevelsToExplode	Integer	Yes	Number of levels (0-60) to explode for a structure. Default: 60
ExplodeOption	Integer	Yes	The explode option for structure: All Current Current and future. By default, current is considered.
ExplodeStandard	String	Yes	Whether to explode the standard structure or not. Y – Explodes the standard structure. N – Do not explode the standard structure. By default, standard structures are exploded.
PublishEntities
OperationalAttributeGroups	String	Yes	Used to turn operational attribute groups on and off in the payload. Y – turn on N – turn off Default Value: Y
UserDefinedAttributeGroups	String	Yes	Used to turn user defined attribute groups on and off in the payload. Y – turn on N – turn off Default Value: Y
ItemRevision	String	Yes	Used to turn item revision details on and off in the payload. Y – turn on N – turn off Default Value: Y
TransactionAttributes	String	Yes	Used to turn transaction attributes on and off in the payload. Y – turn on N – turn off Default Value: Y
RelatedItems	String	Yes	Used to turn related items on and off in the payload. Y – turn on N – turn off Default Value: Y
CustomerItems	String	Yes	Used to turn customer items on and off in the payload. Y – turn on N – turn off Default Value: Y
ManufacturerPartNumbers	String	Yes	Used to turn manufacturer part numbers on and off in the payload. Y – turn on N – turn off Default Value: Y
GTINCrossReferences	String	Yes	Used to turn GTIN cross references on and off in the payload. Y – turn on N – turn off Default Value: Y
AlternateCategoryAssignments	String	Yes	Used to turn alternate category assignments on and off in the payload. Y – turn on N – turn off Default Value: Y
SupplierAssignments	String	Yes	Used to turn supplier assignments on and off in the payload. Y – turn on N – turn off Default Value: Y
ReturnPayload	String	Yes	Flag to control whether the output payload includes the details of the item(s). Y – includes the details of the item in the payload. N – does not include the details of the item in the payload. Default Value: Y
PublishOperationalAttributeGroups
ItemCatalog	String	Yes	Used to turn the item catalog on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: ItemCatalog = N, then ItemCatalog is turned off in the payload. ItemCatalog = Y, then ItemCatalog is turned on in the payload. OperationalAttributeGroups = N and either: ItemCatalog = N, then ItemCatalog is turned off in the payload. ItemCatalog = Y, then ItemCatalog is turned off in the payload
InventoryCharacteristics	String	Yes	Used to turn InventoryCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: InventoryCharacteristics = N, then InventoryCharacteristics is turned off in the payload. InventoryCharacteristics = Y, then InventoryCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: InventoryCharacteristics = N, then InventoryCharacteristics is turned off in the payload. InventoryCharacteristics = Y, then InventoryCharacteristics is turned off in the payload
PhysicalCharacteristics	String	Yes	Used to turn PhysicalCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: PhysicalCharacteristics = N, then PhysicalCharacteristics is turned off in the payload. PhysicalCharacteristics = Y, then PhysicalCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: PhysicalCharacteristics = N, then PhysicalCharacteristics is turned off in the payload. PhysicalCharacteristics = Y, then PhysicalCharacteristics is turned off in the payload
BillsOfMaterialCharacteristics	String	Yes	Used to turn BillsOfMaterialCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: BillsOfMaterialCharacteristics = N, then BillsOfMaterialCharacteristics is turned off in the payload. BillsOfMaterialCharacteristics = Y, then BillsOfMaterialCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: BillsOfMaterialCharacteristics = N, then BillsOfMaterialCharacteristics is turned off in the payload. BillsOfMaterialCharacteristics = Y, then BillsOfMaterialCharacteristics is turned off in the payload
WorkInProcessCharacteristics	String	Yes	Used to turn WorkInProcessCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: WorkInProcessCharacteristics = N, then WorkInProcessCharacteristics is turned off in the payload. WorkInProcessCharacteristics = Y, then WorkInProcessCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: WorkInProcessCharacteristics = N, then WorkInProcessCharacteristics is turned off in the payload. WorkInProcessCharacteristics = Y, then WorkInProcessCharacteristics is turned off in the payload
CostingCharacteristics	String	Yes	Used to turn CostingCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: CostingCharacteristics = N, then CostingCharacteristics is turned off in the payload. CostingCharacteristics = Y, then CostingCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: CostingCharacteristics = N, then CostingCharacteristics is turned off in the payload. CostingCharacteristics = Y, then CostingCharacteristics is turned off in the payload
ProcessingLeadTimeCharacteristics	String	Yes	Used to turn ProcessingLeadTimeCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: ProcessingLeadTimeCharacteristics = N, then ProcessingLeadTimeCharacteristics is turned off in the payload. ProcessingLeadTimeCharacteristics = Y, then ProcessingLeadTimeCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: ProcessingLeadTimeCharacteristics = N, then ProcessingLeadTimeCharacteristics is turned off in the payload. ProcessingLeadTimeCharacteristics = Y, then ProcessingLeadTimeCharacteristics is turned off in the payload
PlanningCharacteristics	String	Yes	Used to turn PlanningCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: PlanningCharacteristics = N, then PlanningCharacteristics is turned off in the payload. PlanningCharacteristics = Y, then PlanningCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: ProcessingLeadTimeCharacteristics = N, then ProcessingLeadTimeCharacteristics is turned off in the payload. ProcessingLeadTimeCharacteristics = Y, then ProcessingLeadTimeCharacteristics is turned off in the payload
PurchasingCharacteristics	String	Yes	Used to turn PurchasingCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: PurchasingCharacteristics = N, then PurchasingCharacteristics is turned off in the payload. PurchasingCharacteristics = Y, then PurchasingCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: PurchasingCharacteristics = N, then PurchasingCharacteristics is turned off in the payload. PurchasingCharacteristics = Y, then PurchasingCharacteristics is turned off in the payload
ReceivingCharacteristics	String	Yes	Used to turn ReceivingCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: ReceivingCharacteristics = N, then ReceivingCharacteristics is turned off in the payload. ReceivingCharacteristics = Y, then ReceivingCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: ReceivingCharacteristics = N, then ReceivingCharacteristics is turned off in the payload. ReceivingCharacteristics = Y, then ReceivingCharacteristics is turned off in the payload
OrderManagementCharacteristics	String	Yes	Used to turn OrderManagementCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: OrderManagementCharacteristics = N, then OrderManagementCharacteristics is turned off in the payload. OrderManagementCharacteristics = Y, then OrderManagementCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: OrderManagementCharacteristics = N, then OrderManagementCharacteristics is turned off in the payload. OrderManagementCharacteristics = Y, then OrderManagementCharacteristics is turned off in the payload
InvoicingCharacteristics	String	Yes	Used to turn InvoicingCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: InvoicingCharacteristics = N, then InvoicingCharacteristics is turned off in the payload. InvoicingCharacteristics = Y, then InvoicingCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: InvoicingCharacteristics = N, then InvoicingCharacteristics is turned off in the payload. InvoicingCharacteristics = Y, then InvoicingCharacteristics is turned off in the payload
WebOptionsCharacteristics	String	Yes	Used to turn WebOptionsCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: WebOptionsCharacteristics = Y and either: WebOptionsCharacteristics = N, then WebOptionsCharacteristics is turned off in the payload. WebOptionsCharacteristics = Y, then InvoicingCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: WebOptionsCharacteristics = N, then WebOptionsCharacteristics is turned off in the payload. WebOptionsCharacteristics = Y, then WebOptionsCharacteristics is turned off in the payload
ServiceCharacteristics	String	Yes	Used to turn ServiceCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: ServiceCharacteristics = N, then ServiceCharacteristics is turned off in the payload. ServiceCharacteristics = Y, then ServiceCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: ServiceCharacteristics = N, then ServiceCharacteristics is turned off in the payload. ServiceCharacteristics = Y, then ServiceCharacteristics is turned off in the payload
AssetCharacteristics	String	Yes	Used to turn AssetCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: AssetCharacteristics = N, then AssetCharacteristics is turned off in the payload. AssetCharacteristics = Y, then AssetCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: AssetCharacteristics = N, then AssetCharacteristics is turned off in the payload. AssetCharacteristics = Y, then AssetCharacteristics is turned off in the payload
ProcessMfgCharacteristics	String	Yes	Used to turn ProcessMfgCharacteristics on or off in the payload. Y – turn on N – turn off Default Value: Y If OperationalAttributeGroups is Y, then only the value for this parameter is considered. For example, if: OperationalAttributeGroups = Y and either: ProcessMfgCharacteristics = N, then ProcessMfgCharacteristics is turned off in the payload. ProcessMfgCharacteristics = Y, then ProcessMfgCharacteristics is turned on in the payload. OperationalAttributeGroups = N and either: ProcessMfgCharacteristics = N, then ProcessMfgCharacteristics is turned off in the payload. ProcessMfgCharacteristics = Y, then ProcessMfgCharacteristics is turned off in the payload
ListOfPublishUserDefinedAttributeGroups
AttributeId	Integer	-	The attribute ID identifies the transaction attribute to include in the payload. Use to configure the list of transaction attributes for a given revision to show in the payload. Use this to provide a list of attribute IDs.
AttributeName	String	-	The attribute internal name identifies the transaction attribute to include in the payload. Use this to provide a list of transaction attribute internal names. If neither AttributeId or AttributeName are provided, then all transaction attributes associated with the item for a given revision are published in the payload. Note: AttributeName takes precedence over AttributeId.
ListOfLanguages
LanguageCode	String	Yes	The language code in which to return the translatable attributes in the payload. For example, US (for American English). By Default, the translatable attributes return in all installed languages. Note: Repeat this parameter multiple times to return output in more than one language.
LanguageName	String	Yes	The language name in which to return the translatable attributes in the payload. For example: English.
ItemsList Important: Provide the following parameters multiple times to publish multiple items.
InventoryItemId	Integer	Yes (batch mode) No (list mode) Yes (single item mode)	Item ID for which to extract the details.
OrganizationId	Integer	Yes (batch mode) No (list mode) Yes (single item mode)	Organization ID to which the publishing item belongs.
OrganizationCode	String	Yes (batch mode) No (list mode) Yes (single item mode)	Organization code to which the publishing item belongs.
RevisionId	Integer	Yes (batch mode) No (list mode) Yes (single item mode)	Revision ID of the publishing item.
Revision	String	Yes (batch mode) No (list mode) Yes (single item mode)	Revision code of the publishing item.
InventoryItemName Important: Provide the following parameters multiple times to publish multiple items.
Segment1..Segment20 Note: Segment1 through Segment20 all have the same characteristics.	String	Batch mode: Yes Single item mode: Yes List of items mode: Yes – If InvetoryItemId is provided for an item. No – If InventoryItemId is not provided for an item.	The individual segment's name that comprises the Publishing item name.
FndSecurity
RESPONSIBILITY_NAME	String	No (Mandatory for any mode other than batch mode.)	Provide the responsibility name for the user. For example: EGO_DEVELOPMENT_MANAGER
RESPONSIBILITY_APPL_NAME	String	No (Mandatory for any mode other than batch mode.)	Application name for the responsibility. For example: EGO
SECURITY_GROUP_NAME	String	Yes	Security group name. For example: STANDARD
NLS_LANGUAGE	String	Yes	The current session language to be used for the Web Service invocation.

Output

The output payload includes item details based on the configurable parameters selected by the user.

Payload

• ListOfItems

  • Item

    • MainCharacteristics - Main characteristics of the item.

      • MainCharTransalation - Translatable values item description and operating unit name.

    • ItemCatalog - Contains the item catalog to which the item belongs.

    • InventoryCharacteristics - Inventory characteristics of the item.

    • PhysicalCharacteristics - Physical characteristics of the item.

    • BillsOfMaterialCharacteristics - Bills of material characteristics of the item.

    • WorkInProcessCharacteristics - Work in process characteristics of the item.

    • CostingCharacteristics - Costing characteristics of the item.

    • ProcessingLeadTimeCharacteristics - Processing lead time characteristics of the item.

    • PlanningCharacteristics - Planning characteristics of the item.

    • PurchasingCharacteristics - Purchasing characteristics of the item.

    • ReceivingCharacteristics - Receiving characteristics of the item.

    • OrderManagementCharacteristics - Order management characteristics of the item.

    • InvoicingCharacteristics - Invoicing characteristics of the item.

    • WebOptionsCharacteristics - Web options characteristics of the item.

    • ServiceCharacteristics - Service characteristics of the item.

    • AssetCharacteristics - Asset characteristics of the item.

    • ProcessMfgCharacteristics - Process manufacturing characteristics.

    • Organization - Organization details of the published item.

      • OrganizationTranslation - Translatable values organization name and operating unit name.

      • OrganizationAttributeGroup - Organization level attribute group.

        • ItemUDA - Organization level user defined attributes.

    • AttributeGroup - Item level attribute groups.

      • ItemUDA - Item level user defined attributes.

    • ItemRevision - Revision details of the item.

      • ItemRevisionTranslation - Translatable value of the revision description.

      • TransactionAttribute - Details of the transaction attributes for a revision.

      • RevisionAttributeGroup - Revision level attribute group.

        • ItemUDA - Revision level user defined attributes.

    • CustomerItem - Customer items associated to the published item.

    • ManufacturerPartNumber - Manufacturer part numbers associated to the published item.

    • SupplierAssignment - Supplier assignments associated to the published item.

      • SupplierAttributeGroup - Supplier level attribute groups.

        • ItemUDA -Supplier level user defined attributes.

      • SupplierSiteAssignment - Supplier site assignments associated to the published item.

        • SupplierSiteAttributeGroup - Supplier site level attribute groups.

          • ItemUDA -Supplier site level user defined attributes.

    • SupplierSiteOrganizationAssignment - Supplier site organization assignments associated to the published item.

      • SupplierSiteOrgAttributeGroup - Supplier site organization level attribute groups.

        • ItemUDA - Supplier site organization level user defined attributes.

    • AlternateCategoryAssignment - Alternate category assignment associated to the published item.

      • AlternateCategoryTranslation - Translatable values of alternate catalog name and category description.

    • RelatedItem - Related Items associated to the published item.

      • RelatedItemTranslations - Translatable values of the related item description.

    • GTINCrossReference - GTIN cross references associated to the published item.

      • GTINCrossRefTranslation - Translatable values of the GTIN description.

  • Status - Status information

    • Error - Details of the errors, if any, along with input identifiers.

      • Code - Error code.

      • Message - Error message.

Method: getStructureDetails

This Web Service method provides an interface to extract the information about an item's structure based on input. The payload only contains the details about the structure and its components. The payload does not contain item definition information for the components.

Modes

You can invoke the getStructureDetails method using three modes. The mode used is derived from the XML elements provided.

Batch Mode

• Retrieves the details of the structure payload for the items defined in a specific batch published from the PIM Publication user interface. Create the publication batch with the list of items and the structure name using PIM Publication user interface.

• Invoke this mode by providing the batch ID. The Web Service returns the structure payload for all items defined in that batch. The parameters provided while creating the batch take precedence over the values provided for the parameters below while invoking the service.

Single Item Mode

• Use this web service to retrieve the structure payload for a given item without creating a publication batch. Provide the single item information directly in the input payload to retrieve the structure details.

• Use the basic input identifiers (InventoryItemId or InventoryItemName) and (OrganizationId or OrganizationCode) and (RevisionId or Revision or RevisionDate) in this mode.

List of Items Mode

• You can also use this web service to retrieve the structure payload for a list of items without creating a publication batch. Apart from the single item mode, this passes a list of item identifiers directly as input to the getStructureDetails method.

• Optionally provides any number of item identifiers for invoking the services.

• Use the list of basic input identifiers (InventoryItemId or InventoryItemName) and (OrganizationId or OrganizationCode) and (RevisionId or Revision or RevisionDate) in this mode.

While invoking the item services in any mode, provide the following WS-Security and Parameter inputs:

WS-Security

Parameter Name	Type	Optional	Description
User Name	String	NO	EBS “Applications User name” (FND User Name)
Password	String	NO	Password for EBS “Applications User”

Parameters

Parameter Name	Type	Optional	Description
StructureQueryParameters	Complex	Yes	Use this part of the XML document for single item mode.
InventoryItemId	Integer	Yes (batch mode) Yes (list mode) No (single item mode)	Use in single item mode to query the payload for a given inventory item ID.
OrganizationId	Integer	Yes (batch mode) Yes (list mode) No (single item mode)	Use with the single item mode to query the payload for an item in a specific organization. Use an existing organization ID in the PIM instance. Use either the Organization Code or the Organization ID to retrieve a payload in this mode.
OrganizationCode	String	Yes (batch mode) Yes (list mode) No (single item mode)	Use with the single item mode to query the payload for an item in a specific organization. Use an existing organization code in the PIM instance. Use either the Organization Code or the Organization ID to retrieve a payload in this mode.
RevisionId	Integer	Yes (batch mode) Yes (list mode) No (single item mode)	Revision ID of the publishing item.
Revision	String	Yes (batch mode) Yes (list mode) No (single item mode)	Revision code of the publishing item.
RevisionDate	Date	Yes (batch mode) No (list mode) No (single item mode)	Use in single item mode to query the payload for a specific revision's structure of an item. Use a valid revision ID for the item provided in InventoryItemId or segments. Provide one of the following fields as input for this mode: Revisionid /RevisionCode/RevisionDate.
StructureName	String	Yes (batch mode) Yes (list mode) No (single item mode)	Use in single item mode to specify the name of the structure for which to query the payload. This is a mandatory input for single item mode.
Segment1 through Segment15	String	Yes (batch mode) Yes (list mode) No (single item mode)	Use in single item mode to specify the name of the item for which to query the payload. Depending on the customer setup for item name segments, provide values for any of the 15 segment fields. Either a value in inventoryItemid or value(s) in one or more of these segments are required in single item mode.
ListofLanguageInformation	Complex	Yes	Use this part of the XML input to provide the language information. Repeat this tag multiple times as needed to specify multiple language information.
LanguageCode	String	Yes	Use in the single item mode to specify the language in which to return the payload. If no value is specified in both LanguageCode and LanguageName tags, the payload returns the information in all languages defined within the PIM instance.
LanguageName	String	Yes	Use in single item mode to specify the language in which to return the payload. If no value is specified in both LanguageCode and LanguageName tags, the payload returns the information in all languages defined within the PIM instance.
LevelsToExplode	Integer	Yes	Use in single item mode to specify the number of levels to explode (0-60) for a structure. Default: 60
BomExploderParameters	Complex	Yes	Use to specify the BOM exploder behavior options as input. All the child elements control BOM explosion behavior.
ExplodeOption	Integer	Yes	The explode options for the structure include: All Current Current and future. By default, current is considered. Default: Current
ExplodeStandard	String	Yes	Determines whether to explode the standard structure or not. Y – Explodes the standard structure. N – Do not explode the standard structure. By default, standard structures are exploded. The explosion only explodes the model and option class.
PublishEntities	Complex	Yes	This specifies configurability options for the payload. By default, the payload includes all information about the structure. This enables users to pick and choose what information to include in the payload by providing values to the elements in this section. Valid values for any configurability options elements are Y or N.
StructureRevision	String	Yes	Specify whether to include the structure revision information as part of the payload.
StructureHeader AttributeGroups	String	Yes	Specify whether to include the structure attribute group information as part of the payload.
StructureComponents	String	Yes	Specify whether to include the structure components information as part of the payload.
ReturnPayload	String	Yes	Flag that controls whether to include details in the output payload. For details, see Controlling the Output Payload.
PublishStructureAttributeGroup	Complex	Yes	By default, the payload includes all attribute groups. However, you can specify the list of attribute groups to include. If attribute groups are specified, then only those attribute groups are included in the payload.
AttributegroupId	Integer	Yes	UDA Attribute Group ID
AttributeGroupName	String	Yes	UDA attribute group name. Specify either the attribute group id or the attribute group name.
PublishStructureComponents	Complex	Yes	Provides payload configurability options for structure component details. All configurability option elements accept Y or N values. Default: Y, so, by default, the payload includes all information.
StructureReferenceDesignators	String	Yes	Specify whether to include the reference designator in the payload.
StructureSubstituteComponents	String	Yes	Specify whether to include the substitute component details in the payload.
ComponentAttributeGroups	String	Yes	Specifies whether to include the component UDAs in the payload.
ComponentExclusions	String	Yes	Specifies whether to include the component exclusions in the payload.
ComponentUDAOverrides	String	Yes	Specifies whether to include the component UDA override details in the payload.
ValueSetExclusions	String	Yes	Specifies whether to include the value set exclusions in the payload.
ListofPublishComponentAttributegroups	Complex	Yes	By default, the payload includes all attribute groups. However, you can specify the list of attribute groups to include. If you specify attribute groups, then only those attribute groups are included in the payload.
AttributegroupId	Integer	Yes	UDA attribute group ID
AttributeGroupName	String	Yes	UDA attribute group name. You can specify either the attribute group ID or attribute group name.
BatchStructureQueryParameters	Complex	Yes	Use this part of the input payload when using batch mode.
BatchId	Integer	Yes	Batch mode creates this batch ID during the item publication process. The return payload includes structure information for all items in this batch.
Configurability	Complex	Yes	All configurability options described for single item mode apply to batch mode.
ListofItemStructureQueryParams	Complex	Yes	Use this part of the input payload when using list item mode. All configurability options described for single item mode apply to the list item mode. The options apply to the whole list.
InventoryItemId	String	Yes	Specifies in list item mode the inventory item ID in the list. You can either specify the ID or name.
OrganizationId	String	Yes	Specify the organization for the item structure. You can either specify the organization ID or organization code.
OrganizationCode	String	Yes	Specify the organization for the item structure. You can either specify the organization ID or organization code.
RevisionId	String	Yes	Specify the revision of the item in the list. Provide either the revision ID or revision code.
Revision	String	Yes	Specify the revision of the item in the list. Provide either the revision ID or revision code.
RevisionDate	String	Yes	Specify the revision date of the item in the list.
StructureName	String	Yes	Specify the structure name for which to return the payload.
Configurability	Complex	Yes	The configurability options are same as single item mode.
FNDSecurity	Complex	Yes	Specifies the FND securities information.
RESPONSIBILITY_NAME	String	No (Mandatory for list mode.)	Provide the responsibility name for the user. For example: EGO_DEVELOPMENT_MANAGER
RESPONSIBILITY_APPL_NAME	String	No (Mandatory for list mode.)	Application name for the responsibility. For example: EGO
SECURITY_GROUP_NAME	String	Yes	Security group name. For example: STANDARD
NLS_LANGUAGE	String	Yes	The current session language used for the Web Service invocation.

Output

The output payload includes structure details based on the configurable parameters selected by the user.

Payload

• ListOfStructureHeaders

  • StructureHeader

    • AssemblyItemId - Inventory item identifier.

    • AssemblyItemName - Name of the assembly item.

    • Segment1..segment20 - Item name Segment1 through Segment20.

    • CommonAssemblyItemId - The inventory item ID of the common BOM assembly. This is applicable only for common BOMs.

    • CommonAssemblyItemName - Name of the common assembly item.

    • OrganizationId - Organization identifier.

    • OrganizationCode - Organization code.

    • SpecificAssemblyComment - Comment.

    • AssemblyType - 1 indicates a Manufacturing Bill. 2 indicates an Engineering Bill.

    • AlternateBomDesignator - Alternate designator code or structure name.

    • CommonBillSequenceId - Identifier of the common bill.

    • BillSequenceId - Bill Identifier.

    • CommonOrganizationId - Organization identifier of common bill.

    • CommonOrganizationCode - Organization Code for the common bill.

    • OperatingUnitId - Operating unit of the structure organization.

    • PendingFromEcn - Name of the ECN.

    • NextExplodeDate - Next date when pre-explosion will be refreshed.

    • ProjectId - Project identifier for Project Manufacturing.

    • TaskId - Task identifier for Project Manufacturing.

    • OriginalSystemReference - Original system that data for the current record has come from.

    • StructureTypeId - Structure Type ID.

    • ImplementationDate - Implementation date.

    • ObjName - Object name identified if this is an assembly structure for an ICC structure.

    • EffectivityControl - Specifies effectivity control for the structure.

    • IsPreferred - Identifies if this is a preferred BOM.

    • SourceBillSequenceId

    • LastUpdateDate - Standard Who column.

    • LastUpdateLogin - Standard Who column.

    • AttributeCategory - Descriptive flexfield structure defining column.

    • Attribute1..Attribute15 - Descriptive flexfield segment.

    • Pk1Value..PK5Value - Additional primary key of the structure object.

    • Language - Language code.

    • PlanLevel - Plan level.

    • StructureRevision - Structure revision details.

      • RevisionId - Assembly item revision ID.

      • Revision - Assembly item revision code.

      • RevisionLabel - Assembly item revision label.

      • RevisionReason - Revision reason.

      • ChangeNotice -Engineering change order number.

      • EcnInitiationDate - ECO Initiation date.

      • ImplementationDate - ECO implementation date.

      • ImplementedSerialNumber - Implemented serial nmber.

      • Description - Description

      • LifecycleId - Lifecycle identifier

      • CurrentPhaseId -Current Phase ID

      • ObjectVersionNumber - Object version number tracks row updates.

      • LastUpdateDate - Standard Who columns.

      • …

      • LastUpdateLogin - Standard Who columns.

      • EffectivityDate - Revision effectivity date.

      • RevisedItemSequenceId - Revised item unique identifier.

      • AttributeCategory - Descriptive flexfield structure defining column.

      • Attribute1 - Descriptive flexfield segment.

      • …

      • Attribute15 - Descriptive flexfield segment.

      • RevisionDescription

        • LanguageCode - Language code

        • Description - Item revision translated description.

    • StructureHeaderAttributeGroup

      • AttributegroupId - Identifier of user defined attribute group.

      • AttributeGroupName - User defined attribute group name.

      • ExtensionId - Row identifier in table BOM_STRUCTURES_EXT_B.

      • StructureHeaderUDA

        • Name - Internal name of structure header attribute group.

        • CharValue - Character value of the UDA.

        • …

        • TranslatedCharValue - Translated char value for an UDA

        • HeaderTranslatableUDA - Translatable UDA details.

          • LanguageCode - Language code

          • TranslatedCharValue - Translated value of user defined attribute.

        • HeaderUDADescription - Header UDA description.

          • Description - Description of user defined attribute.

          • LanguageCode - Language code.

        • HeaderUDADisplayName

          • DisplayName - Display name of user defined attribute.

          • LanguageCode - Language code.

      • HeaderAGDescription

        • Description - Description of attribute group.

        • LanguageCode - Language code.

      • HeaderAGDisplayName

        • DisplayName - Display name of attribute group.

        • LanguageCode - Language code.

    • StructureComponent - List of this assembly structure's direct child components with their operational attributes.

      • AssemblyItemId - Inventory Item Id of assembly item.

      • OrganizationId - Organization Id

      • CommonComponentSequenceId - Common component sequence ID.

      • ComponentSequenceId - Component sequence ID.

      • OperationSeqNum - Operation sequence number to which this component belongs.

      • ComponentItemId - Inventory Item ID for the component item.

      • ComponentCode - Path of component in an assembly structure.

      • ComponentItemName - Concatenated component item name.

      • Segment1 - Individual Segment1 of component name.

      • …

      • Segment20 - Individual Segment20 of component name.

      • Description - Component item description.

      • ItemSequenceNumber - Item number of this component on parent structure.

      • PrimaryUomCode - Component UOM code.

      • PrimaryUnitOfMeasure - Component UOM name.

      • BasisType - Component basis type.

      • ComponentQuantity - Component quantity.

      • AutoRequestMaterial - Auto request flag.

      • CurrentFuturePastFlag - Flag indicating if component is current or future effective.

      • EffectivityDate - Effectivity date.

      • DisableDate - Disable Date

      • ImplementationDate - Implementation Date

      • ChangeNotice - Change order name.

      • PlanningFactor - Planning factor.

      • ComponentYieldFactor - Yield factor.

      • EnforceIntRequirements - Enforce Integer Requirements.

      • IncludeInCostRollup - Include in cost rollup.

      • BomItemType - BOM item type of component.

      • WipSupplyType - WIP supply type.

      • SupplySubinventory - Supply subinventory.

      • SupplyLocatorId - Supply locator ID

      • CheckAtp - Check ATP flag.

      • Optional - Optional flag.

      • MutuallyExclusiveOptions - Mutually exclusive options.

      • LowQuantity - Low quantity.

      • HighQuantity - High quantity.

      • SoBasis - Sales order basis.

      • ShippingAllowed - Shipping allowed.

      • IncludeOnShipDocs - Include on shipping docs.

      • RequiredToShip - Required to ship.

      • TopItemId - Inventory item ID of top assembly.

      • TopBillSequenceId - Bill sequence ID of top assembly.

      • ParentBomItemType - Item type of parent assembly.

      • ExplosionType - Explosion type.

      • PlanLevel - Plan level.

      • ExtendedQuantity - Extended quantity.

      • SortOrder - Sort order for the hierarchy.

      • CompBillSeqId - Component bill sequence ID.

      • CompCommonBillSeqId - Common bill sequence ID.

      • ParentSortOrder - Parent assembly sort order for the hierarchy.

      • CompSourceBillSeqId - Component source bill sequence ID.

      • SourceBillSequenceId - Source bill sequence ID.

      • EcoForProduction - Indicates if this component on an Engineering Change Order is only for WIP jobs.

      • OptionalOnModel - Optional on model.

      • IncludeOnBillDocs - Include on billing documents.

      • BaseItemId - Base item identifier.

      • AtpComponentsFlag - Flag indicating whether an item has components requiring an ATP check.

      • AtpFlag - Flag indicating whether to check ATP when item is ordered.

      • PickComponentsFlag - Flag indicating to pick all shippable components.

      • ReplenishToOrderFlag - Replenish to order flag.

      • ShippableItemFlag - Shippable item flag.

      • CustomerOrderFlag - Customer order flag.

      • InternalOrderFlag - Internal order flag.

      • CustomerOrderEnabledFlag - Customer Order Enabled Flag

      • InternalOrderEnabledFlag - Internal Order Enabled Flag

      • SoTransactionsFlag - Sales Order Transactions Flag

      • LoopFlag - Flag indicating a loop in the hierarchy.

      • ItemNum - Sequence number of item on parent structure.

      • RexplodeFlag - ReExplode Flag

      • SuggestedVendorName - Suggested vendor name

      • VendorId - Vendor ID

      • UnitPrice - Unit Price

      • CreationDate - Standard Who column

      • CreatedBy - Standard Who Column

      • LastUpdateDate - Standard Who Column

      • Context - Description flex field context

      • Attribute1 - Descriptive flex field segment

      • …

      • Attribute15 - Descriptive flex field segment

      • QuantityRelated - Identifier to indicate if this component has quantity related reference designators.

      • FromEndItemRevId - From End Item Revision ID

      • ToEndItemRevId - To End Item Revision ID

      • RevisionId - Revision ID

      • Revision - Revision code

      • StructureSubstituteComponents - List of substitute components for this structure component.

        • SubstituteComponentId - Inventory item ID of substitute component.

        • SubstituteCompItemName - Concatenated substitute component item name.

        • Segment1 - Individual segment1 of substitute component name

          …

        • Segment20 - Individual Segment20 of substitute component name.

        • SubstituteItemQuantity - Quantity of substitute items needed to replace the full component quantity.

        • ComponentSequenceId - Component Sequence ID of parent component.

        • AcdType - Type to indicate add or delete on an engineering change order.

        • ChangeNotice - Engineering change order number.

        • EnforceIntRequirements - Enforce integer requirements.

        • CommonComponentSequenceId - Common component sequence ID.

        • LastUpdateDate - Standard Who Column

        • …

        • LastUpdateLogin - Standard Who Column

        • AttributeCategory - Descriptive flexfield structure defining column.

        • Attribute1 - Descriptive flexfield segment.

        • …

        • Attribute15 - Descriptive flexfield segment

        • OriginalSystemReference - Original system from where the data for the current record came.

      • StructureReferenceDesignators - List of reference designators for the parent component.

        • ComponentSequenceId - Component Sequence ID of the parent component.

        • ComponentReferenceDesignator - Component reference designator.

        • RefDesignatorComment - Reference designator comment.

        • CommonComponentSequenceId - Common component sequence ID.

        • ChangeNotice - Engineering change order number.

        • AcdType - Type to indicate add or delete on an engineering change order.

        • LastUpdateDate - Standard Who column

        • …

        • LastUpdateLogin - Standard Who Column

        • AttributeCategory - Descriptive flexfield structure defining column.

        • Attribute1 - Descriptive flexfield segment.

        • …

        • Attribute15 - Descriptive flexfield segment.

        • OriginalSystemReference - Original system from where data for the current record came.

      • ComponentAttributeGroup - List of attribute groups associated with this component.

        • AttributegroupId - Attribute Group ID

        • AttributeGroupName - Attribute group name

        • ExtensionId - Unique identifier for an attribute group and row.

        • ComponentUDA - List of attributes and their values associated with this attribute group.

          • Name - Attribute name

          • CharValue - Attribute character value

          • …

          • DatetimeValue - Attribute datetime value

          • TranslatedCharValue - Attribute translated character value in the default language.

          • ComponentTranslatableUDA - Translatable attributes values in given languages.

            • LanguageCode - Language code.

            • TranslatedCharValue - Attribute translated character value in this language.

          • ComponentUDADescription - List of component UDA descriptions in given languages.

            • Description - Translated description in given language.

            • LanguageCode - Language code.

          • ComponentUDADisplayName - List of component UDA display names in given languages.

            • DisplayName - Translated display name in given language.

            • LanguageCode - Language code.

          • ComponentAGDescription - List of component attribute group descriptions in given languages.

            • Description - Translated description in given language.

            • LanguageCode - Language code.

          • ComponentAGDisplayName - List of component attribute group display names in given languages.

            • DisplayName - Translated display names in given languages.

            • LanguageCode - Language code.

  • Status - Status information.

    • ListOfErrors - Error information.

      • Message - Error message.

      • Code - Error code.

      • LanguageCode - Language code of the error message in the payload.

      • InputIdentifier - The input identifier of the error record in the input payload.

    • ListOfWarnings - Warning information

      • Message - Warning message

      • Code - Warning Code

      • LanguageCode - Language code in which the warning details are specified in the output payload.

  • AdditionalInfo - Additional info section when returnPayload input flag is set to false.

    • SessionId - Session ID for invocation.

    • EntityCount - Output entity count.

  • ContextInfo - The part of the XML document containing the context specific information for the top item in the Structure.

    • ComponentPath - Component path details.

      • ComponentItemList - List of items in the component path order.

        • ItemReference - Component item details in the component path order.

          • Name - Name of the item

          • Sequence - Sequence number specifying the component path for this component.

          • BomItemType - BOM item type of the component in the component path.

          • CatalogCategoryName - Item catalog category name of the component item.

        • ComponentCode - The internal component code of the component path.

        • OverrideAttrGrp - Override attribute group details.

          • AttributegroupId - Component attribute group name for which an override is defined in the above component path.

          • AttributeGroupName - Component attribute group name.

          • ExtensionId - Internal extension ID stored to refer the row in the extension table.

          • ComponentCode - Component code that corresponds to the override component path.

          • ComponentOverrideUDA - Details about the override UDA columns.

            • Name - Name of the UDA.

            • CharValue - Char value.

            • …

            • TranslatedCharValue - Translated values.

• ComponentTranslatableUDA - Translated UDA values.

  • ComponentExclusion Component - Exclusion details for the above component path. This exists only if the user defined an exclusion.

    • ComponentCode - Internal component code for the component path.

    • FromRevisionId - The effective revision from ID for the exclusion.

    • ToRevisionId - The effective revision to ID for the exclusion.

    • FromRevision - The effective revision from for the exclusion.

    • ToRevision - The effective revision to for the exclusion.

  • ValuesetExclusion - Valueset exclusion details. This part of the payload includes information if the user defined any specific valueset exclusions in this component path.

    • ExcludedValue - Excluded value for the value set.

    • ComponentCode - Internal component code for the component path.

    • FromRevisionId - The effective revision from ID for the exclusion.

    • ToRevisionId - The effective revision to ID for the exclusion.

    • FromRevision - The effective revision from for the exclusion.

    • ToRevision - The effective revision to for the exclusion.

Related Topics

Oracle Product Hub Web Services Overview

Publishing Overview, Oracle Product Hub User's Guide

Publishing Items and Structures, Oracle Product Hub User's Guide

Controlling the Output Payload

Error Reporting

Controlling the Output Payload

The output payload of Web Services when publishing to external systems can grow very large due to the number of entities and sub-entities returned. This can become a bottleneck in performance when the Web Service client consumes the payload.

To facilitate processing smaller portions of the entire payload at a time, use the optional parameter ReturnPayload as part of the input parameter list for every Web Service. When the Web Service client intends to process smaller payloads, the client invokes the Web Service method with the ReturnPayload parameter set to 'False'.

If the ReturnPayload parameter is set to 'False', the Web Service method does not return the payload and instead returns a set of parameters in the payload to use for retrieving the information from a database view.

Example when ReturnPayload = False

The output returned contains the following information in AdditionalInfo:

<listOfStructureHeaders
     xmlns:ns0="http://xmlns.oracle.com/apps/bom/structure/service"
     xmlns="">
<AdditionalInfo>
<SessionId>7612</SessionId>
<EntityCount>0</EntityCount>
</AdditionalInfo>
.........
</listOfStructureHeaders>

Using the values of SessionId and EntityCount, the Web Service consumer can retrieve the payloads for individual entities from the database view EGO_PUB_WS_OUTPUT_V in the Oracle Product Hub instance. The columns of the database view EGO_PUB_WS_OUTPUT_V that you can use to retrieve the output payload in parts is provided below:

Column Name	Description
SESSION_ID	Session ID corresponding to this call to Web Service.
WEB_SERVICE_NAME	Webservice method name.
SEQUENCE_ID	Sequence of the entity in the payload.
STATUS	Marker column for consuming the Web Service entity.
XMLCONTENT	Output payload corresponding to one entity in the payload.
XMLCLOB	Output in clob.
CREATION_DATE	Creation Date

Each row in the view corresponds to one entity returned by the Web Service method.

Related Topics

Item Catalog Category Web Service

Value Set Web Service

Item Web Service

Error Reporting

Error Reporting

Any errors in the execution of the Web Service are reported in the output payload Status section. The following two tables show the different errors that display when publishing to external systems or to Oracle Product Hub systems. The error information is contained in the format shown below.

Output Payload Status Section When Publishing to External Systems

Payload	Description
<Status>	-
<Error>	-
<Code>EGO_INVALID_ITEM_ID</Code>	Error code
<Message>Invalid Inventory Item Id</Message>	Error message
<InputIdentifier>	Input that caused the error.
<Parameter>	Parameters list for the input.
<Name>OrganizationId</Name>	Parameter name
<Value>204</Value>	Parameter value
…..	-
…..	-
</InputIdentifier>	-
</Error>	-
</Status>	-

Output Payload Status Section When Publishing to Oracle Product Hub Systems

Payload	Description
<Status>	-
<Error>	-
<Code>EGO_SYNC_ENTITY_ERROR</Code>	Error code
<Message>Entity VS115_0006 failed the import process in target system USER_ENTERED.</Message>	Error message
<LanguageCode>US</LanguageCode>	Language code
<SystemCode>USER_ENTERED</SystemCode>	System code for the destination Oracle Product Hub system where the error occurred.
<InputIdentifier>	Input that caused the error.
<Parameter>	Parameters list for the input.
<Name>VS</Name>	Parameter name
<Value>VS115_0006</Value>	Parameter value
…..	-
…..	-
</InputIdentifier>	-
</Error>	-
<Warning>	-
<Code>EGO_SYNC_ENTITY_WARNING</Code>	Warning code
<Message>One of the entities associated with AG115_0006 failed the import process in target system USER_ENTERED.</Message>	Warning message
<LanguageCode>US</LanguageCode>	Language code
<SystemCode>USER_ENTERED</SystemCode>	System code for the destination Oracle Product Hub system where the error occurred.
<InputIdentifier>	Input that caused the warning.
<Parameter>	Parameters list for the input.
<Name>AG</Name>	Parameter name
<Value>AG115_0006</Value>	Parameter value
…..	-
…..	-
</InputIdentifier>	-
<Warning>	-
</Status>	-

TheWeb Service client can extract and make use of this information to report errors returned from the Web Service call.

Related Topics

Oracle Product Hub Web Services Overview

Publishing Overview, Oracle Product Hub User's Guide

Item Catalog Category Web Service

Attribute Group Web Service

Value Set Web Service

Item Web Service