Get one Product Management flexfield
get
/fscmRestApi/resources/11.13.18.05/productManagementFlexfieldsMetadata/{productManagementFlexfieldsMetadataUniqID}
Request
Path Parameters
-
productManagementFlexfieldsMetadataUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Flexfields Metadata resource and used to uniquely identify an instance of Flexfields Metadata. The client should not generate the hash key value. Instead, the client should query on the Flexfields Metadata collection resource in order to navigate to a specific instance of Flexfields Metadata to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : productManagementFlexfieldsMetadata-item-response
Type:
Show Source
object-
AttributeGroupMetadata: array
Attribute Groups Metadata
Title:
Attribute Groups MetadataDefinitions and configuration data used for logically grouping related Flexfield attributes. It specifies data that organizes attribute metadata within the flexfield metadata. -
ContextCategoryCode: string
Read Only:
trueMaximum Length:255Value that identifies the context category for the flexfield. -
ContextCode: string
Read Only:
trueMaximum Length:80Value that identifies the context for the flexfield metadata. -
DescriptiveFlexfieldCode: string
Read Only:
trueMaximum Length:40A brief description of the flexfield code. -
FlexfieldUsageCode: string
Read Only:
trueMaximum Length:30Value that identifies the page category for the flexfield. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PageCategoryCode: string
Read Only:
trueMaximum Length:800Value that identifies the context category for the flexfield. -
PageCode: string
Read Only:
trueMaximum Length:30Code that identifies the page for the flexfield. -
PageId: integer
Read Only:
trueValue that uniquely identifies the page for the flexfield. -
SequenceNumber: integer
(int32)
Read Only:
trueValue that identifies the sequence number for the flexfield.
Nested Schema : Attribute Groups Metadata
Type:
arrayTitle:
Attribute Groups MetadataDefinitions and configuration data used for logically grouping related Flexfield attributes. It specifies data that organizes attribute metadata within the flexfield metadata.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productManagementFlexfieldsMetadata-AttributeGroupMetadata-item-response
Type:
Show Source
object-
AdvancedQbeFlag: boolean
Read Only:
trueMaximum Length:1Value that identifies the indicator for the Advanced QBE, which controls the functionality and interface of the Query By Example fields. A Yes value enables the QBE features, while a No value disables them. -
ApiName: string
Read Only:
trueMaximum Length:255Value that identifies the API name for the flexfield. -
AttributesMetadata: array
Attributes Metadata
Title:
Attributes MetadataDefinitions and configuration data that describe flexfield metadata for attributes. These define attribute fields in attribute-group metadata used to represent specific types of information. -
CExtensionAttribute2: string
Read Only:
trueMaximum Length:150Value for the CExtAttribute2 attribute in the attribute group. -
CExtensionAttribute3: string
Read Only:
trueMaximum Length:150Value for the CExtAttribute3 attribute in the attribute group. -
CExtensionAttribute4: string
Read Only:
trueMaximum Length:150Value for the CExtAttribute4 attribute in the attribute group. -
CExtensionAttribute5: string
Read Only:
trueMaximum Length:150Value for the CExtAttribute5 attribute in the attribute group. -
ContextCode: string
Read Only:
trueMaximum Length:80Value that identifies the context for the attribute group. -
ContextDescription: string
Read Only:
trueMaximum Length:240Value that describes the context for the attribute group. -
ContextIdentifier: string
Read Only:
trueMaximum Length:30Value that identifies the context identifier for the attribute group. -
ContextName: string
Read Only:
trueMaximum Length:80Name of a context for an attribute group. -
ContextUniqueId: string
Read Only:
trueValue that uniquely identifies the context for the attribute group. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the attribute group. -
EditPrivilegeName: string
Read Only:
trueMaximum Length:400Name of the privilege for editing the attribute group. -
EnabledFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the attribute group is enabled. Contains one of the following values: Y or N. If Y, the attribute group is enabled for use. If N, the attribute group isn't enabled for use. The default value is N. -
FlexfieldUsageCode: string
Read Only:
trueMaximum Length:30Value that identifies the page category for the flexfield. -
InstructionHelpText: string
Read Only:
trueMaximum Length:400Value that indicates the instruction help text for the attribute group. -
LastUpdateDate: string
(date-time)
Read Only:
trueValue that indicates the date and time when the extensible Flexfield row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64Value that indicates the user who most recently updated the attribute group. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Value that indicates the login associated with the user who most recently updated the team. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MasterToChildOrganization: string
Read Only:
trueMaximum Length:150Master-to-child organization for the attribute group. -
MultirowFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the flexfield is multirow. A Yes value indicates that the metadata represents a multirow attribute, while a No value indicates that the metadata represents a single-row attribute. -
ProtectedFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the attribute group can be modified or updated. A Yes value indicates the attribute group can't be updated, while a No value indicates the attribute group can be updated. -
RWDEffLayout: integer
Read Only:
trueValue that indicates the Read or Write Default Effective layout value, which determines whether the default layout is applied to the attribute group. A Yes value allows the attribute to be effective-dated, while a No value indicates the attribute value isn't effective-dated. -
StyleToSku: string
Read Only:
trueMaximum Length:150Value indicating whether the attribute group is used for capturing specific values to support style and SKUs. A Yes value indicates the attribute group is enabled for attributes used in SKUs, while a No value indicates the attribute group won't be used for style SKUs. -
TranslatableFlag: boolean
Read Only:
trueMaximum Length:1Value indicating whether the data for the attribute group is translatable. A Yes value indicates the data can be translated, while a No value indicates the value isn't translatable. -
VariantAttribute: string
Read Only:
trueMaximum Length:150Variant attribute that identifies product variants. -
ViewPrivilegeName: string
Read Only:
trueMaximum Length:400Privilege name that provides access to the Attribute Group Metadata.
Nested Schema : Attributes Metadata
Type:
arrayTitle:
Attributes MetadataDefinitions and configuration data that describe flexfield metadata for attributes. These define attribute fields in attribute-group metadata used to represent specific types of information.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-item-response
Type:
Show Source
object-
ApplicationId: integer
(int64)
Read Only:
trueValue that uniquely identifies the application for the attribute. -
BiEnabledFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the attribute is enabled for use with business intelligence. A Yes value indicates the attribute is enabled for business intelligence, while a No value indicates the attribute isn't enabled for business intelligence. -
BiEqualizationTag: string
Read Only:
trueMaximum Length:30Indicates whether the attribute data will be standardized for business intelligence analysis. A Yes value indicates the attribute data is standardized for analysis, while a No value indicates it's not standardized. -
CExtensionAttribute1: string
Read Only:
trueMaximum Length:150Value that indicate the CExtAttribute1 attribute for the attribute. -
CExtensionAttribute2: string
Read Only:
trueMaximum Length:150Value that indicate the CExtAttribute2 attribute for the attribute. -
CExtensionAttribute3: string
Read Only:
trueMaximum Length:150Value that indicate the CExtAttribute3 attribute for the attribute. -
CExtensionAttribute4: string
Read Only:
trueMaximum Length:150Value that indicate the CExtAttribute4 attribute for the attribute. -
CExtensionAttribute5: string
Read Only:
trueMaximum Length:150Value that indicate the CExtAttribute5 attribute for the attribute. -
CheckboxCheckedValue: string
Read Only:
trueMaximum Length:30Value that indicates the checkbox's checked value. -
CheckboxUncheckedValue: string
Read Only:
trueMaximum Length:30Value that indicates the checkbox's unchecked value. -
ColumnName: string
Read Only:
trueMaximum Length:30Value that indicates the column name. -
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the attribute. -
CreationDate: string
(date-time)
Read Only:
trueDate and time of the creation of the item. -
DefaultType: string
Read Only:
trueMaximum Length:30Value that indicates the default type for the attribute. -
DefaultValue: string
Read Only:
trueMaximum Length:255Value that indicates the default value for the attribute. -
DerivationValue: string
Read Only:
trueMaximum Length:80Value that indicates the attribute value is dynamically determined or calculated. -
DescriptiveFlexfieldCode: string
Read Only:
trueMaximum Length:40A brief description of the flexfield code. -
DisplayHeight: integer
(int32)
Read Only:
trueValue that indicates the vertical size of the data entry box for the attribute. -
DisplayType: string
Read Only:
trueMaximum Length:30Value that indicates how the attribute will be displayed. -
DisplayWidth: integer
(int32)
Read Only:
trueValue that indicates the horizontal size of the data entry box for the attribute. -
DynamicUrl: string
Read Only:
trueMaximum Length:1000Value that indicates the attribute allows an embedded clickable hyperlink in the user interface. -
EnabledFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether the attribute group is enabled for use. A Yes value indicates the attribute group is enabled, while a No value indicates it isn't enabled. The default value is N. -
IndexedFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether a database index has been created for the attribute. A Yes value indicates Oracle will attempt to include the attribute in an index for the flexfield, while a No value indicates the attribute won't be included in the index. -
InFieldHelpText: string
Read Only:
trueMaximum Length:160Value that indicates a short message, hint, or instruction that will appear near or within the display field for the attribute. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the attribute metadata row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the attribute. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login associated with the user who most recently updated the attribute. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MultirowUniqueKeyFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether one or more attributes are part of a unique key for each attribute group. A Yes value indicates the same value can't be entered in multiple rows, while a No value indicates uniqueness won't be enforced. -
Prompt: string
Read Only:
trueMaximum Length:80Value that indicates the display label or field name shown in the user interface. -
RangeType: string
Read Only:
trueMaximum Length:30Value that indicates the Range Type value, which specifies that start and end date values will be captured for the attribute creating the range. -
ReadOnlyFlag: boolean
Read Only:
trueMaximum Length:1Value that indicates the Read-Only indicator, which controls whether the attribute can be edited or updated. A Yes value indicates the attribute is read-only, while a No value indicates the attribute can be updated or edited. -
RequiredFlag: boolean
Read Only:
trueMaximum Length:1Value that indicates a value must be entered for the attribute field. A Yes value indicates the attribute must be entered before saving, while a No value indicates the entry of the value is optional. -
SegmentCode: string
Read Only:
trueMaximum Length:30Value that indicates the code that identifies the segment for the flexfield's attribute. -
SegmentDescription: string
Read Only:
trueMaximum Length:240Value that indicates the attribute. -
SegmentIdentifier: string
Read Only:
trueMaximum Length:30Unique identifier name or code for the attribute. -
SegmentName: string
Read Only:
trueMaximum Length:60Name of the attribute. -
SegmentUniqueId: string
Read Only:
trueUnique identifier for an segment. -
SequenceNumber: integer
(int32)
Read Only:
trueSequence Number value indicating order the attribute will be displayed. -
ShortPrompt: string
Read Only:
trueMaximum Length:80Condensed version of the main prompt. -
ShowValueDescriptionFlag: boolean
Read Only:
trueMaximum Length:1Value that indicates whether the internal code and description for the attribute will be displayed. A Yes value will display both the internal code and description, while a No value will display the internal code only. -
TerminologyHelpText: string
Read Only:
trueMaximum Length:80No value will display the internal code only. -
UomClassCode: string
Read Only:
trueMaximum Length:255Code of the unit of measure. -
UomClassId: string
Read Only:
trueMaximum Length:10Unique identifier for the Unit of Measure (UOM) Class for attributes with type number and UOM. -
ValueSetId: integer
(int64)
Read Only:
trueUnique identifier for the value set. -
ValueSetMetadata: array
Value Sets Metadata
Title:
Value Sets MetadataConfiguration, attributes, and rules for a set of predefined values used for data validation and field population.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Value Sets Metadata
Type:
arrayTitle:
Value Sets MetadataConfiguration, attributes, and rules for a set of predefined values used for data validation and field population.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-ValueSetMetadata-item-response
Type:
Show Source
object-
CreatedBy: string
Read Only:
trueMaximum Length:64User who created the value set. -
CreationDate: string
(date-time)
Read Only:
trueDate and time of the creation of the value set. -
DataSecurityObjectName: string
Read Only:
trueMaximum Length:60Underlying business object or entity for security control of the value set. -
Description: string
Read Only:
trueMaximum Length:240Value that indicates the value set. -
HybridSearchEnabled: string
Read Only:
trueMaximum Length:30Indicates how the user searches for value sets. -
IndependentValueSetId: integer
(int64)
Read Only:
trueUnique numeric or alphanumeric identifier for each value set. -
LastUpdateDate: string
(date-time)
Read Only:
trueDate and time when the value set metadata row was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64User who most recently updated the value set. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32Login of the user who last updated the team. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MaximumLength: integer
(int32)
Read Only:
trueValue that indicate the Maximum Length value indicating the maximum number of characters that can be entered for text based value sets. -
MaximumValue: string
Read Only:
trueMaximum Length:150Highest numeric or data value that the user can enter in the display for value set values. -
MinimumValue: string
Read Only:
trueMaximum Length:150Smallest numeric or earliest data value that the user can enter in the display for value set values. -
ModuleId: string
Read Only:
trueMaximum Length:32Unique identifier system-generated used to associate the value set and the attribute. -
Precision: integer
(int32)
Read Only:
trueNumber of digits that can appear after the decimal point for value sets. -
ProtectedFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether a value set can or can't be edited. Yes value indicates the value set can't be edited. No value indicates the value set can be edited. -
Scale: integer
(int32)
Read Only:
trueNumber of digits allowed for the number data in a value set. -
SecurityEnabledFlag: boolean
Read Only:
trueMaximum Length:1Indicates if the value set enforces row-level security. Yes value indicates the value set is security -enabled. No value indicates the user with access will see all values of the value set. -
TableValueSetWhereClause: string
Read Only:
trueMaximum Length:4000Indicates which rows from the source table are valid choices for the attribute when using a SQL WHERE clause to filter the data. -
UppercaseOnlyFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether all user-entered or imported values are converted to upper case for the value set. A Yes value automatically converts the values, while a No value allows mixed or lower case values. -
ValidationType: string
Read Only:
trueMaximum Length:30Indicates whether Oracle checks and restricts the allowed value. -
ValueDataType: string
Read Only:
trueMaximum Length:30Indicates the type of data that can be entered, selected, or assigned to an attribute using a value set. -
ValueSetCode: string
Read Only:
trueMaximum Length:60Unique identifier name for a value set used for an attribute. -
ValueSetDiscriminator: string
Read Only:
trueMaximum Length:30Technical property used to identify the type of purpose the value set. -
ValueSetId: integer
Read Only:
trueUnique identifier for the value set. -
ValueSetIdentifier: string
Read Only:
trueMaximum Length:30Unique key used to reference the value set. -
ValueSubtype: string
Read Only:
trueMaximum Length:30Additional specifications, constraints, or formatting for a value set. -
ZeroFillFlag: boolean
Read Only:
trueMaximum Length:1Indicates whether numeric values are padded with leading zeros to match the required field length. A Yes value adds leading zeros automatically, while a No value doesn't.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- AttributeGroupMetadata
-
Parameters:
- productManagementFlexfieldsMetadataUniqID:
$request.path.productManagementFlexfieldsMetadataUniqID
Definitions and configuration data used for logically grouping related Flexfield attributes. It specifies data that organizes attribute metadata within the flexfield metadata. - productManagementFlexfieldsMetadataUniqID: