Create a menu item
post
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root 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.
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 : 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.