Get a menu
get
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryDefinitions/{RegistryName}
Request
Path Parameters
-
RegistryName: string
The unique idenfitier of the menu.
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 : publicSectorRegistryDefinitions-item
Type:
Show Source
object
-
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 descripion of the menu. -
HostName(optional):
string
Maximum Length:
30
The web application that uses the menu for navigation. -
Label(optional):
string
Maximum Length:
30
The short descripion of the menu. -
links(optional):
array Items
Title:
Items
Link Relations -
RegistryName(optional):
string
Maximum Length:
30
The unique idenfitier of the menu. -
Securities(optional):
array Menu Security Assignments
Title:
Menu Security Assignments
The menus resource is used to view, create, modify, or delete a navigation 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 : Menu Security Assignments
Type:
array
Title:
Menu Security Assignments
The menus resource is used to view, create, modify, or delete a navigation menu.
Show Source
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 : publicSectorRegistryDefinitions-Securities-item
Type:
Show Source
object
-
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 security assignment.