Get all lookup types
get
/fscmRestApi/resources/11.13.18.05/publicSectorLookupTypes
Request
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 -
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:- simpleSearchFinder: Finds lookup types that match the keyword specified. Finder Variables:
- value; string; The keyword used to find a lookup type such as lookup code or meaning.
- PrimaryKey: Finds a lookup type that matches the primary key criteria specified. Finder Variables:
- LookupType; string; The lookup type.
- ViewApplicationId; integer; The unique application identifier.
- simpleSearchFinder: Finds lookup types that match the keyword specified. Finder Variables:
-
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.
-
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 attributes. 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 -
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".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorLookupTypes
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
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(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorLookupTypes-item
Type:
Show Source
object
-
CreatedBy(optional):
string
Maximum Length:
64
The user who created the lookup type. -
CreationDate(optional):
string(date-time)
The date and time on which the lookup type was created.
-
CustomizationLevel(optional):
string
Title:
Configuration Level
Maximum Length:1
The configuration level code such as system level or user level. -
Description(optional):
string
Title:
Description
Maximum Length:240
The description of the lookup type code. -
LastUpdateDate(optional):
string(date-time)
The date on which the lookup type was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64
The user who last updated the lookup type. -
links(optional):
array Items
Title:
Items
Link Relations -
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 type code. -
ModuleId(optional):
string
Title:
Module
Maximum Length:32
The unique module identifier associated with a logical business area such as billing or payment. -
PscLookupValue(optional):
array Lookup Values
Title:
Lookup Values
The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level. -
ReferenceGroupName(optional):
string
Title:
Reference Group Name
Maximum Length:30
The reference group name. -
UserModuleName(optional):
string
Title:
User Module Name
Maximum Length:512
The module name displayed to the user. -
ViewApplicationId(optional):
integer(int64)
Title:
Application
The application ID associated with product like permits.
Nested Schema : Lookup Values
Type:
array
Title:
Lookup Values
The lookup type resource is used to view, create, delete or modify lookup types. The object stores lookup type information such as lookup type and configuration level.
Show Source
-
Array of:
object publicSectorLookupTypes-PscLookupValue-item
Discriminator:
ViewApplicationId
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.
Nested Schema : publicSectorLookupTypes-PscLookupValue-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.