Get a lookup value
get
/fscmRestApi/resources/11.13.18.05/publicSectorLookupValues/{publicSectorLookupValuesUniqID}
Request
Path Parameters
-
publicSectorLookupValuesUniqID: integer
This is the hash key of the attributes which make up the composite key--- LookupType, LookupCode, ViewApplicationId and SetId ---for the Lookup Values resource and used to uniquely identify an instance of Lookup Values. The client should not generate the hash key value. Instead, the client should query on the Lookup Values collection resource with a filter on the primary key values in order to navigate to a specific instance of Lookup Values.
For example: publicSectorLookupValues?q=LookupType=<value1>;LookupCode=<value2>;ViewApplicationId=<value3>;SetId=<value4>
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. 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 attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorLookupValues-item
Type:
object
Discriminator:
Show Source
ViewApplicationId
-
AttributeCategory(optional):
string
Title:
Attribute Category
Maximum Length:30
The attribute category code. -
CreatedBy(optional):
string
Maximum Length:
64
The date and time on which the lookup value was created. -
CreationDate(optional):
string(date-time)
The user who created the lookup value.
-
Description(optional):
string
Title:
Description
Maximum Length:240
The description of the lookup value code. -
DisplaySequence(optional):
integer(int64)
Title:
Display Sequence
The order in which lookup types are displayed. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether a lookup value is enabled. The default value is true. -
EndDateActive(optional):
string(date)
Title:
End Date
The date on which the lookup value code becomes inactive. -
LastUpdateDate(optional):
string(date-time)
The date on which the lookup value was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the lookup value. -
links(optional):
array Items
Title:
Items
Link Relations -
LookupCode(optional):
string
Title:
Lookup Code
Maximum Length:30
The lookup value code. -
LookupType(optional):
string
Title:
Lookup Type
Maximum Length:30
The lookup type code. -
Meaning(optional):
string
Title:
Meaning
Maximum Length:80
The meaning of the lookup value code. -
SetId(optional):
integer(int64)
The unique identifier for a set of lookups.
-
StartDateActive(optional):
string(date)
Title:
Start Date
The date on which the lookup value code becomes active. -
Tag(optional):
string
Title:
Tag
Maximum Length:150
The tag of the lookup value code. Tags on lookup codes enable you to add a label to your lookup codes. A tag can be used to categorize lookups based on facilitating searches or guiding how a lookup should be used. -
ViewApplicationId:
integer(int64)
Title:
Application
The unique application identifier associated with a product.
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.