Jump to

• Request
• Response

Get one value set

get

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

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.
• SegmentUniqueId(required): string
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• ValueSetId(required): integer
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• 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 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-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"
    }
}

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."
        }
    }
}

Back to Top