Jump to

• Request
• Response

Get all attribute group attributes

get

/fscmRestApi/resources/11.13.18.05/productManagementFlexfieldsMetadata/{productManagementFlexfieldsMetadataUniqID}/child/AttributeGroupMetadata/{AttributeGroupMetadataUniqID}/child/AttributesMetadata

Request

Path Parameters

• AttributeGroupMetadataUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Attribute Groups Metadata resource and used to uniquely identify an instance of Attribute Groups Metadata. The client should not generate the hash key value. Instead, the client should query on the Attribute Groups Metadata collection resource in order to navigate to a specific instance of Attribute Groups Metadata to get the hash key.
• 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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Finds the attribute metadata based on the primary key criteria.
    Finder Variables
    • SegmentUniqueId; string; Value that uniquely identifies the attribute.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• 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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ApplicationId; integer; Value that uniquely identifies the application for the attribute.
  • BiEnabledFlag; boolean; Indicates 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; Indicates 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; Value that indicate the CExtAttribute1 attribute for the attribute.
  • CExtensionAttribute2; string; Value that indicate the CExtAttribute2 attribute for the attribute.
  • CExtensionAttribute3; string; Value that indicate the CExtAttribute3 attribute for the attribute.
  • CExtensionAttribute4; string; Value that indicate the CExtAttribute4 attribute for the attribute.
  • CExtensionAttribute5; string; Value that indicate the CExtAttribute5 attribute for the attribute.
  • CheckboxCheckedValue; string; Value that indicates the checkbox's checked value.
  • CheckboxUncheckedValue; string; Value that indicates the checkbox's unchecked value.
  • ColumnName; string; Value that indicates the column name.
  • CreatedBy; string; User who created the attribute.
  • CreationDate; string; Date and time of the creation of the item.
  • DefaultType; string; Value that indicates the default type for the attribute.
  • DefaultValue; string; Value that indicates the default value for the attribute.
  • DerivationValue; string; Value that indicates the attribute value is dynamically determined or calculated.
  • DescriptiveFlexfieldCode; string; A brief description of the flexfield code.
  • DisplayHeight; integer; Value that indicates the vertical size of the data entry box for the attribute.
  • DisplayType; string; Value that indicates how the attribute will be displayed.
  • DisplayWidth; integer; Value that indicates the horizontal size of the data entry box for the attribute.
  • DynamicUrl; string; Value that indicates the attribute allows an embedded clickable hyperlink in the user interface.
  • EnabledFlag; boolean; Indicates 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.
  • InFieldHelpText; string; Value that indicates a short message, hint, or instruction that will appear near or within the display field for the attribute.
  • IndexedFlag; boolean; Indicates 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.
  • LastUpdateDate; string; Date and time when the attribute metadata row was last updated.
  • LastUpdateLogin; string; Login associated with the user who most recently updated the attribute.
  • LastUpdatedBy; string; User who most recently updated the attribute.
  • MultirowUniqueKeyFlag; boolean; Indicates 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; Value that indicates the display label or field name shown in the user interface.
  • RangeType; string; Value 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; Value 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; Value 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; Value that indicates the code that identifies the segment for the flexfield's attribute.
  • SegmentDescription; string; Value that indicates the attribute.
  • SegmentIdentifier; string; Unique identifier name or code for the attribute.
  • SegmentName; string; Name of the attribute.
  • SegmentUniqueId; string; Unique identifier for an segment.
  • SequenceNumber; integer; Sequence Number value indicating order the attribute will be displayed.
  • ShortPrompt; string; Condensed version of the main prompt.
  • ShowValueDescriptionFlag; boolean; Value 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; No value will display the internal code only.
  • UomClassCode; string; Code of the unit of measure.
  • UomClassId; string; Unique identifier for the Unit of Measure (UOM) Class for attributes with type number and UOM.
  • ValueSetId; integer; Unique identifier for the value set.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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 Top

Response

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.

Body ()

Root Schema : productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-item-response"
            }
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-item-response

Type: object

Show Source

• ApplicationId: integer (int64)
  Read Only: true

  Value that uniquely identifies the application for the attribute.
• BiEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates 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: true

  Maximum Length: 30

  Indicates 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: true

  Maximum Length: 150

  Value that indicate the CExtAttribute1 attribute for the attribute.
• CExtensionAttribute2: string
  Read Only: true

  Maximum Length: 150

  Value that indicate the CExtAttribute2 attribute for the attribute.
• CExtensionAttribute3: string
  Read Only: true

  Maximum Length: 150

  Value that indicate the CExtAttribute3 attribute for the attribute.
• CExtensionAttribute4: string
  Read Only: true

  Maximum Length: 150

  Value that indicate the CExtAttribute4 attribute for the attribute.
• CExtensionAttribute5: string
  Read Only: true

  Maximum Length: 150

  Value that indicate the CExtAttribute5 attribute for the attribute.
• CheckboxCheckedValue: string
  Read Only: true

  Maximum Length: 30

  Value that indicates the checkbox's checked value.
• CheckboxUncheckedValue: string
  Read Only: true

  Maximum Length: 30

  Value that indicates the checkbox's unchecked value.
• ColumnName: string
  Read Only: true

  Maximum Length: 30

  Value that indicates the column name.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the attribute.
• CreationDate: string (date-time)
  Read Only: true

  Date and time of the creation of the item.
• DefaultType: string
  Read Only: true

  Maximum Length: 30

  Value that indicates the default type for the attribute.
• DefaultValue: string
  Read Only: true

  Maximum Length: 255

  Value that indicates the default value for the attribute.
• DerivationValue: string
  Read Only: true

  Maximum Length: 80

  Value that indicates the attribute value is dynamically determined or calculated.
• DescriptiveFlexfieldCode: string
  Read Only: true

  Maximum Length: 40

  A brief description of the flexfield code.
• DisplayHeight: integer (int32)
  Read Only: true

  Value that indicates the vertical size of the data entry box for the attribute.
• DisplayType: string
  Read Only: true

  Maximum Length: 30

  Value that indicates how the attribute will be displayed.
• DisplayWidth: integer (int32)
  Read Only: true

  Value that indicates the horizontal size of the data entry box for the attribute.
• DynamicUrl: string
  Read Only: true

  Maximum Length: 1000

  Value that indicates the attribute allows an embedded clickable hyperlink in the user interface.
• EnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates 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: true

  Maximum Length: 1

  Indicates 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: true

  Maximum Length: 160

  Value 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: true

  Date and time when the attribute metadata row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the attribute.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login associated with the user who most recently updated the attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MultirowUniqueKeyFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates 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: true

  Maximum Length: 80

  Value that indicates the display label or field name shown in the user interface.
• RangeType: string
  Read Only: true

  Maximum Length: 30

  Value 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: true

  Maximum Length: 1

  Value 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: true

  Maximum Length: 1

  Value 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: true

  Maximum Length: 30

  Value that indicates the code that identifies the segment for the flexfield's attribute.
• SegmentDescription: string
  Read Only: true

  Maximum Length: 240

  Value that indicates the attribute.
• SegmentIdentifier: string
  Read Only: true

  Maximum Length: 30

  Unique identifier name or code for the attribute.
• SegmentName: string
  Read Only: true

  Maximum Length: 60

  Name of the attribute.
• SegmentUniqueId: string
  Read Only: true

  Unique identifier for an segment.
• SequenceNumber: integer (int32)
  Read Only: true

  Sequence Number value indicating order the attribute will be displayed.
• ShortPrompt: string
  Read Only: true

  Maximum Length: 80

  Condensed version of the main prompt.
• ShowValueDescriptionFlag: boolean
  Read Only: true

  Maximum Length: 1

  Value 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: true

  Maximum Length: 80

  No value will display the internal code only.
• UomClassCode: string
  Read Only: true

  Maximum Length: 255

  Code of the unit of measure.
• UomClassId: string
  Read Only: true

  Maximum Length: 10

  Unique identifier for the Unit of Measure (UOM) Class for attributes with type number and UOM.
• ValueSetId: integer (int64)
  Read Only: true

  Unique identifier for the value set.
• ValueSetMetadata: array Value Sets Metadata
  Title: Value Sets Metadata

  Configuration, attributes, and rules for a set of predefined values used for data validation and field population.

{
    "type":"object",
    "properties":{
        "ApplicationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the application for the attribute.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BiEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BiEqualizationTag":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CExtensionAttribute1":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicate the CExtAttribute1 attribute for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CExtensionAttribute2":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicate the CExtAttribute2 attribute for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CExtensionAttribute3":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicate the CExtAttribute3 attribute for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CExtensionAttribute4":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicate the CExtAttribute4 attribute for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CExtensionAttribute5":{
            "maxLength":150,
            "type":"string",
            "description":"Value that indicate the CExtAttribute5 attribute for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckboxCheckedValue":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the checkbox's checked value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CheckboxUncheckedValue":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the checkbox's unchecked value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ColumnName":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the column name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time of the creation of the item.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the default type for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DefaultValue":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the default value for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DerivationValue":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the attribute value is dynamically determined or calculated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DescriptiveFlexfieldCode":{
            "maxLength":40,
            "type":"string",
            "description":"A brief description of the flexfield code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayHeight":{
            "type":"integer",
            "description":"Value that indicates the vertical size of the data entry box for the attribute.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "DisplayType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates how the attribute will be displayed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayWidth":{
            "type":"integer",
            "description":"Value that indicates the horizontal size of the data entry box for the attribute.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "DynamicUrl":{
            "maxLength":1000,
            "type":"string",
            "description":"Value that indicates the attribute allows an embedded clickable hyperlink in the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "InFieldHelpText":{
            "maxLength":160,
            "type":"string",
            "description":"Value that indicates a short message, hint, or instruction that will appear near or within the display field for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IndexedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the attribute metadata row was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login associated with the user who most recently updated the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MultirowUniqueKeyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Prompt":{
            "maxLength":80,
            "type":"string",
            "description":"Value that indicates the display label or field name shown in the user interface.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RangeType":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the Range Type value, which specifies that start and end date values will be captured for the attribute creating the range.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentCode":{
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the code that identifies the segment for the flexfield's attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentDescription":{
            "maxLength":240,
            "type":"string",
            "description":"Value that indicates the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentIdentifier":{
            "maxLength":30,
            "type":"string",
            "description":"Unique identifier name or code for the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentName":{
            "maxLength":60,
            "type":"string",
            "description":"Name of the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SegmentUniqueId":{
            "type":"string",
            "description":"Unique identifier for an segment.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"Sequence Number value indicating order the attribute will be displayed.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "ShortPrompt":{
            "maxLength":80,
            "type":"string",
            "description":"Condensed version of the main prompt.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShowValueDescriptionFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Value 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TerminologyHelpText":{
            "maxLength":80,
            "type":"string",
            "description":"No value will display the internal code only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UomClassCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code of the unit of measure.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UomClassId":{
            "maxLength":10,
            "type":"string",
            "description":"Unique identifier for the Unit of Measure (UOM) Class for attributes with type number and UOM.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetId":{
            "type":"integer",
            "description":"Unique identifier for the value set.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ValueSetMetadata":{
            "title":"Value Sets Metadata",
            "type":"array",
            "description":"Configuration, attributes, and rules for a set of predefined values used for data validation and field population.",
            "items":{
                "$ref":"#/components/schemas/productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-ValueSetMetadata-item-response"
            },
            "x-cardinality":"1"
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : Value Sets Metadata

Type: array

Title: Value Sets Metadata

Configuration, attributes, and rules for a set of predefined values used for data validation and field population.

Show Source

• Array of: object productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-ValueSetMetadata-item-response

{
    "title":"Value Sets Metadata",
    "type":"array",
    "description":"Configuration, attributes, and rules for a set of predefined values used for data validation and field population.",
    "items":{
        "$ref":"#/components/schemas/productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-ValueSetMetadata-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : productManagementFlexfieldsMetadata-AttributeGroupMetadata-AttributesMetadata-ValueSetMetadata-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the value set.
• CreationDate: string (date-time)
  Read Only: true

  Date and time of the creation of the value set.
• DataSecurityObjectName: string
  Read Only: true

  Maximum Length: 60

  Underlying business object or entity for security control of the value set.
• Description: string
  Read Only: true

  Maximum Length: 240

  Value that indicates the value set.
• HybridSearchEnabled: string
  Read Only: true

  Maximum Length: 30

  Indicates how the user searches for value sets.
• IndependentValueSetId: integer (int64)
  Read Only: true

  Unique numeric or alphanumeric identifier for each value set.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the value set metadata row was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the value set.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Login of the user who last updated the team.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MaximumLength: integer (int32)
  Read Only: true

  Value 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: true

  Maximum Length: 150

  Highest numeric or data value that the user can enter in the display for value set values.
• MinimumValue: string
  Read Only: true

  Maximum Length: 150

  Smallest numeric or earliest data value that the user can enter in the display for value set values.
• ModuleId: string
  Read Only: true

  Maximum Length: 32

  Unique identifier system-generated used to associate the value set and the attribute.
• Precision: integer (int32)
  Read Only: true

  Number of digits that can appear after the decimal point for value sets.
• ProtectedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates 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: true

  Number of digits allowed for the number data in a value set.
• SecurityEnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates 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: true

  Maximum Length: 4000

  Indicates 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: true

  Maximum Length: 1

  Indicates 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: true

  Maximum Length: 30

  Indicates whether Oracle checks and restricts the allowed value.
• ValueDataType: string
  Read Only: true

  Maximum Length: 30

  Indicates the type of data that can be entered, selected, or assigned to an attribute using a value set.
• ValueSetCode: string
  Read Only: true

  Maximum Length: 60

  Unique identifier name for a value set used for an attribute.
• ValueSetDiscriminator: string
  Read Only: true

  Maximum Length: 30

  Technical property used to identify the type of purpose the value set.
• ValueSetId: integer
  Read Only: true

  Unique identifier for the value set.
• ValueSetIdentifier: string
  Read Only: true

  Maximum Length: 30

  Unique key used to reference the value set.
• ValueSubtype: string
  Read Only: true

  Maximum Length: 30

  Additional specifications, constraints, or formatting for a value set.
• ZeroFillFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates 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.

{
    "type":"object",
    "properties":{
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time of the creation of the value set.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DataSecurityObjectName":{
            "maxLength":60,
            "type":"string",
            "description":"Underlying business object or entity for security control of the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Value that indicates the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HybridSearchEnabled":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates how the user searches for value sets.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IndependentValueSetId":{
            "type":"integer",
            "description":"Unique numeric or alphanumeric identifier for each value set.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the value set metadata row was last updated.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Login of the user who last updated the team.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumLength":{
            "type":"integer",
            "description":"Value that indicate the Maximum Length value indicating the maximum number of characters that can be entered for text based value sets.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":4
            },
            "x-queryable":true
        },
        "MaximumValue":{
            "maxLength":150,
            "type":"string",
            "description":"Highest numeric or data value that the user can enter in the display for value set values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MinimumValue":{
            "maxLength":150,
            "type":"string",
            "description":"Smallest numeric or earliest data value that the user can enter in the display for value set values.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":32,
            "type":"string",
            "description":"Unique identifier system-generated used to associate the value set and the attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Precision":{
            "type":"integer",
            "description":"Number of digits that can appear after the decimal point for value sets.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "ProtectedFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Scale":{
            "type":"integer",
            "description":"Number of digits allowed for the number data in a value set.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":3
            },
            "x-queryable":true
        },
        "SecurityEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TableValueSetWhereClause":{
            "maxLength":4000,
            "type":"string",
            "description":"Indicates which rows from the source table are valid choices for the attribute when using a SQL WHERE clause to filter the data.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UppercaseOnlyFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValidationType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates whether Oracle checks and restricts the allowed value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueDataType":{
            "maxLength":30,
            "type":"string",
            "description":"Indicates the type of data that can be entered, selected, or assigned to an attribute using a value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetCode":{
            "maxLength":60,
            "type":"string",
            "description":"Unique identifier name for a value set used for an attribute.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetDiscriminator":{
            "maxLength":30,
            "type":"string",
            "description":"Technical property used to identify the type of purpose the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetId":{
            "type":"integer",
            "description":"Unique identifier for the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSetIdentifier":{
            "maxLength":30,
            "type":"string",
            "description":"Unique key used to reference the value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueSubtype":{
            "maxLength":30,
            "type":"string",
            "description":"Additional specifications, constraints, or formatting for a value set.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ZeroFillFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates 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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top