Get all menu items
get
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
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 the menu items whose name, label, or description contains the specified keyword. Finder Variables:
- value; string; The keyword to search in the name, label, or description of menu items.
- PrimaryKey: Finds the menu item that matches the primary key criteria specified. Finder Variables:
- ItemName; string; The unique identifier of the menu item.
- RegistryName; string; The unique identifier of the menu.
- SimpleSearchFinder: Finds the menu items whose name, label, or description contains the specified keyword. 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 : publicSectorRegistryItemDefinitions
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 : publicSectorRegistryItemDefinitions-item
Type:
Show Source
object
-
Attributes(optional):
array Menu Item Attributes
Title:
Menu Item Attributes
The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry". -
Configurations(optional):
array Menu Item Configurations
Title:
Menu Item Configurations
The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry". -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false. -
Description(optional):
string
Maximum Length:
100
The full description of the menu item. -
DisplayMode(optional):
string
Maximum Length:
4
Indicates whether to show the menu item based on the device form factor. Valid values are ALL for always displaying the menu item, NSFF for only displaying the menu item on medium and larger devices, SFF for only displaying the menu item on small form factor devices such as phones, and NONE for always hide the menu item. -
HostName(optional):
string
Maximum Length:
30
The web application serves the target page of the menu link. -
ItemName(optional):
string
Maximum Length:
30
The unique identifier of the menu item. -
ItemType(optional):
string
Maximum Length:
1
Indicates whether the menu item is a menu folder or menu link. Valid values are F for menu folder, and L for menu link. -
Label(optional):
string
Maximum Length:
50
The short description of the menu item. -
links(optional):
array Items
Title:
Items
Link Relations -
ModuleId(optional):
string
Maximum Length:
32
The product feature area the menu item is associated with. -
ParentName(optional):
string
Maximum Length:
30
The unique identifier of the parent menu folder. -
RegistryName(optional):
string
Maximum Length:
30
The unique identifier of the menu. -
Securities(optional):
array Menu Item Security Assignments
Title:
Menu Item Security Assignments
The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry". -
SecurityMode(optional):
string
Maximum Length:
1
Indicates the security type of the menu item. Valid values are P for public menu item and S for secured menu item. Menu item security should be assigned through the security console. -
SeedDataLock(optional):
integer(int32)
Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0.
-
SequenceNumber(optional):
integer(int32)
The sequence number of the menu item inside the parent menu folder.
-
TargetLocation(optional):
string
Maximum Length:
4
Indicates how to display the target page when the menu link is clicked. Valid values are DFLT for replacing only the content area of the current page, TOP for replacing the current page entirely with a full page reload, NEW for opening the target page in a new browser window, and MOD for opening the target page inside a modal window on top of the current page. -
TargetType(optional):
string
Maximum Length:
4
Indicates the target page type of the menu item. Valid values are FLDR for menu folder, JET for delivered page, and URL for external page. -
TargetUri(optional):
string
The target page URL of the menu link.
-
ValidFromDate(optional):
string(date-time)
The start date when the menu item is displayed.
-
ValidToDate(optional):
string(date-time)
The end date when the menu item is displayed.
Nested Schema : Menu Item Attributes
Type:
array
Title:
Menu Item Attributes
The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry".
Show Source
Nested Schema : Menu Item Configurations
Type:
array
Title:
Menu Item Configurations
The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry".
Show Source
Nested Schema : Menu Item Security Assignments
Type:
array
Title:
Menu Item Security Assignments
The menu items resource is used to view, create, modify, or delete a navigation menu item. The term "menu" is also referred to as "registry".
Show Source
Nested Schema : publicSectorRegistryItemDefinitions-Attributes-item
Type:
Show Source
object
-
AttributeId(optional):
string
Maximum Length:
30
The unique identifier of the menu item attribute. -
AttributeLongValue(optional):
string
The static long value of the menu item attribute.
-
AttributeShortValue(optional):
string
Maximum Length:
250
The static short value of the menu item attribute. -
AttributeStringValue(optional):
string
Maximum Length:
250
The label of the menu item attribute. -
AttributeTypeValue(optional):
string
Maximum Length:
4
The type value of the menu item attribute. -
ItemName(optional):
string
Maximum Length:
30
The unique identifier of the menu item. -
links(optional):
array Items
Title:
Items
Link Relations -
RegistryName(optional):
string
Maximum Length:
30
The unique identifier of the menu.
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 : publicSectorRegistryItemDefinitions-Configurations-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
The unique identifier of the agency that is associated with this menu item attribute customization data.
-
AttributeId(optional):
string
Maximum Length:
30
The unique identifier of the menu item attribute. -
AttributeLongValue(optional):
string
The static long value of the menu item attribute.
-
AttributeShortValue(optional):
string
Maximum Length:
250
The static short value of the menu item attribute. -
AttributeStringValue(optional):
string
Maximum Length:
250
The label of the menu item attribute. -
AttributeTypeValue(optional):
string
Maximum Length:
4
The type value of the menu item attribute. -
DeletedFlag(optional):
string
Maximum Length:
1
Indicates whether the record is logically deleted (true or false). Valid values are true for deleted record, and false for active record. The default value is false. -
ItemName(optional):
string
Maximum Length:
30
The unique identifier of the menu item. -
links(optional):
array Items
Title:
Items
Link Relations -
RegistryName(optional):
string
Maximum Length:
30
The unique identifier of the menu. -
SeedDataLock(optional):
integer(int32)
Indicates whether the row is delivered seed data or customer data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified. The default value is 0.
Nested Schema : publicSectorRegistryItemDefinitions-Securities-item
Type:
Show Source
object
-
ItemName(optional):
string
Maximum Length:
30
The unique identifier of the menu item. -
links(optional):
array Items
Title:
Items
Link Relations -
RegistryName(optional):
string
Maximum Length:
30
The unique identifier of the menu. -
RoleName(optional):
string
Maximum Length:
250
The unique identifier of the menu item security assignment.