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.
Attention: 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.
This Web Service method provides an interface to extract the information about the value set and/or its hierarchy based on input.
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:
|
| 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. |
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