Get a value set
get
<servername>/fscmRestApi/resources/11.13.18.05/valueSets/{valueSets_Id}
Request
Path Parameters
-
valueSets_Id(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=
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:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- 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.
Nested Schema : ItemProperties
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : valueSets-item
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the value set. -
CreationDate: string
(date-time)
Read Only:
true
The date when the value set was created. -
DataSecurityObjectName: string
Title:
Data Security Resource Name
Maximum Length:60
The name of the corresponding data security object for this value set. When you enable security on a value set, the data security object name is an existing value set or one that you want to create. -
Description: string
Title:
Description
Maximum Length:240
The description of the value set. -
IndependentValueSetCode: string
Title:
Value Set Code
Maximum Length:60
The value set code of the independent value set. -
IndependentValueSetId: integer
(int64)
Title:
Independent Value Set
The identifier of the independent value set. You can use an independent value set to specify a user-defined set of valid values. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the value set was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the value set. -
MaximumLength: integer
(int32)
Title:
Maximum Length
The maximum number of characters allowed in a value set value. -
MaximumValue: string
Title:
Maximum Value
Maximum Length:150
The maximum character value allowed for the value set. -
MaximumValueDate: string
(date)
Title:
Maximum Value
The maximum date value allowed for the value set. -
MaximumValueNumber: number
Title:
Maximum Value
The maximum number value allowed for the value set. -
MaximumValueTimestamp: string
(date-time)
Title:
Maximum Value
The maximum timestamp value allowed for the value set. -
MinimumValue: string
Title:
Minimum Value
Maximum Length:150
The minimum character value allowed for the value set. -
MinimumValueDate: string
(date)
Title:
Minimum Value
The minimum date value allowed for the value set. -
MinimumValueNumber: number
Title:
Minimum Value
The minimum number value allowed for the value set. -
MinimumValueTimestamp: string
(date-time)
Title:
Minimum Value
The minimum timestamp value allowed for the value set. -
ModuleId: string
Title:
Module
Maximum Length:32
The identifier of the module, which is a node at product line, product family, application, or logical business area level. -
Precision: integer
(int32)
Title:
Precision
The maximum number of significant digits allowed for a value set value. -
ProtectedFlag: string
Title:
Protected
Maximum Length:1
Indicates whether the value set is protected aganist updates. The value sets marked as protected can't be edited or deleted. -
Scale: integer
(int32)
Title:
Scale
The maximum number of digits that can follow the decimal point for a value set value. -
SecurityEnabledFlag: string
Title:
Security enabled
Maximum Length:1
Default Value:N
Indicates whether data security is enabled for the value set value. The default value is false. -
UppercaseOnlyFlag: string
Title:
Uppercase only
Maximum Length:1
Default Value:N
Indicates whether only uppercase letters are allowed in a value set value. The default value is false. -
ValidationType: string
Title:
Validation Type
Maximum Length:30
The validatuin type describes the way the value set values are validated. For example Dependent, Independent, and Format validation types. -
ValueDataType: string
Title:
Value Data Type
Maximum Length:30
The value data type such as Character, Number, Date, and Date Time. -
ValueSetCode: string
Title:
Value Set Code
Maximum Length:60
The value set code of the value set. For each value set, you can define a context whose code is the value set code, and whose context-sensitive segments are shown for the values of that value set. -
ValueSetId: integer
(int64)
Read Only:
true
The identifier of the value set. -
ValueSubtype: string
Title:
Value Subtype
Maximum Length:30
The value subtype such as Text, Translated text, Numeric digits only, Time (20:08), and Time (20:08:08). -
ZeroFillFlag: string
Title:
Zero fill
Maximum Length:1
Default Value:N
Indicates whether the value set value is padded on the left with zeroes. The default value is false.
- IndependentValueSetCodeLOV
-
Method: getPath:
/fndSetupApi/resources/11.13.18.05/valueSets/{valueSets_Id}/lov/IndependentValueSetCodeLOV
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : valueSets-validationTable-item
Type:
Show Source
object
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the value set validation table. -
CreationDate: string
(date-time)
Read Only:
true
The date when the value set validation table was created. -
DescriptionColumnLength: integer
(int32)
Title:
Description Column Length
Read Only:true
The length of the description column. -
DescriptionColumnName: string
Title:
Description Column Name
Maximum Length:240
The column name that holds the description of the value set value. -
DescriptionColumnType: string
Title:
Description Column Type
Read Only:true
Maximum Length:30
The data type of the description column. -
EnabledFlagColumnName: string
Title:
Enabled Flag Column Name
Maximum Length:240
The column name that holds the enabled flag of the value set value. -
EndDateColumnName: string
Title:
End Date Column Name
Maximum Length:240
The column name that holds the end date of the value set value. -
FromClause: string
Title:
FROM Clause
Maximum Length:240
The SQL FROM clause that identifies the database tables or views on which the value set is based. -
IdColumnLength: integer
(int32)
Title:
ID Column Length
Read Only:true
The length of the identifier column. -
IdColumnName: string
Title:
ID Column Name
Maximum Length:240
The column name that holds the identifier of the value set value. -
IdColumnType: string
Title:
ID Column Type
Read Only:true
Maximum Length:30
The data type of the identifier column. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the value set validation table was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the value set validation table. -
OrderByClause: string
Title:
ORDER BY Clause
Maximum Length:4000
The SQL ORDER BY clause that dertermines the order of the value set values in the list of values. -
StartDateColumnName: string
Title:
Start Date Column Name
Maximum Length:240
The column name that holds the start date of the value set value. -
ValueAttributesTableAlias: string
Title:
Value Attributes Table Alias
Maximum Length:30
The SQL alias of the table or view that holds the key flexfield value attribute values. -
ValueColumnLength: integer
(int32)
Title:
Value Column Length
Read Only:true
The length of the value column. -
ValueColumnName: string
Title:
Value Column Name
Maximum Length:240
The column name that holds the value set value. -
ValueColumnType: string
Title:
Value Column Type
Read Only:true
Maximum Length:30
The data type of the value column. -
ValueSetId: integer
(int64)
Read Only:
true
The identifier for the parent value set. -
WhereClause: string
Title:
WHERE Clause
Maximum Length:4000
The SQL WHERE clause that filters the rows of the tables or views in the FROM clause.
Nested Schema : schema
Type:
Show Source
object
-
AccountType: string
Maximum Length:
30
Identifies the account type of account segment values. -
ControlAccount: string
Maximum Length:
30
Identifies the third party control account. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the value. -
CreationDate: string
(date-time)
Read Only:
true
The date when the value was created. -
Description: string
Title:
Description
Maximum Length:240
The description of the value. -
DetailBudgetingAllowed: string
Maximum Length:
30
Specifies whether budget entry is allowed for a given segment value. -
DetailPostingAllowed: string
Maximum Length:
30
Specifies whether posting is allowed for a given segment value. -
EnabledFlag: string
Title:
Enabled
Maximum Length:1
Default Value:Y
Indicates whether the value is currently enabled for use. The default value is true. -
EndDateActive: string
(date)
Title:
End Date
The date till which the value is available for use. -
FinancialCategory: string
Maximum Length:
30
The financial category of the value. -
IndependentValue: string
Title:
Independent Value
Maximum Length:150
Independent character value. -
IndependentValueDate: string
(date)
Title:
Independent Value
Independent date value. -
IndependentValueNumber: number
Title:
Independent Value
Independent number value. -
IndependentValueTimestamp: string
(date-time)
Title:
Independent Value
Independent timestamp value. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the value was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the value. -
ReconciliationFlag: string
Maximum Length:
30
Indicates whether reconciliation is enabled. -
SortOrder: integer
(int64)
Title:
Sort Order
The number that indicated the order in which the values appear in the list of values. -
StartDateActive: string
(date)
Title:
Start Date
The date from when the value is available for use. -
SummaryFlag: string
Maximum Length:
30
Denotes summarization. -
TranslatedValue: string
Title:
Translated Value
Maximum Length:150
Translated value. -
Value: string
Title:
Value
Maximum Length:150
Character value. -
ValueDate: string
(date)
Title:
Value
Date value. -
ValueId: integer
(int64)
Title:
Value ID
Read Only:true
The identifier for the value set value. -
ValueNumber: number
Title:
Value
Number value. -
ValueTimestamp: string
(date-time)
Title:
Value
Timestamp value.