Create a menu item
post
/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
Attributes: array
Menu Item Attributes
Title:
Menu Item Attributes
The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute. -
Configurations: array
Menu Item Configurations
Title:
Menu Item Configurations
The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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(required): string
Maximum Length:
100
The full description of the menu item. -
DisplayMode(required): 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: string
Maximum Length:
30
The web application serves the target page of the menu link. -
ItemName(required): string
Maximum Length:
30
The unique identifier of the menu item. -
ItemType(required): 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(required): string
Maximum Length:
50
The short description of the menu item. -
ModuleId(required): string
Maximum Length:
32
The product feature area the menu item is associated with. -
ParentName(required): string
Maximum Length:
30
The unique identifier of the parent menu folder. -
RegistryName(required): string
Maximum Length:
30
The unique identifier of the menu. -
SecurityMode(required): 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: integer
(int32)
Default Value:
0
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(required): integer
(int32)
The sequence number of the menu item inside the parent menu folder.
-
TargetLocation(required): 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(required): 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: string
The target page URL of the menu link.
-
ValidFromDate: string
(date-time)
The start date when the menu item is displayed.
-
ValidToDate: 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 item attributes resource is used to view, create, modify, or delete a navigation menu item attribute.
Show Source
Nested Schema : Menu Item Configurations
Type:
array
Title:
Menu Item Configurations
The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data.
Show Source
Nested Schema : publicSectorRegistryItemDefinitions-Attributes-item-post-request
Type:
Show Source
object
-
AttributeId: string
Maximum Length:
30
The unique identifier of the menu item attribute. -
AttributeLongValue: string
The static long value of the menu item attribute.
-
AttributeShortValue: string
Maximum Length:
250
The static short value of the menu item attribute. -
AttributeStringValue: string
Maximum Length:
250
The label of the menu item attribute. -
AttributeTypeValue: string
Maximum Length:
4
The type value of the menu item attribute. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
Maximum Length:
30
The unique identifier of the menu item. -
RegistryName: string
Maximum Length:
30
The unique identifier of the menu. -
SeedDataLock: integer
(int32)
Default Value:
0
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-Configurations-item-post-request
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency that is associated with this menu item attribute customization data.
-
AttributeId: string
Maximum Length:
30
The unique identifier of the menu item attribute. -
AttributeLongValue: string
The static long value of the menu item attribute.
-
AttributeShortValue: string
Maximum Length:
250
The static short value of the menu item attribute. -
AttributeStringValue: string
Maximum Length:
250
The label of the menu item attribute. -
AttributeTypeValue: string
Maximum Length:
4
The type value of the menu item attribute. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
Maximum Length:
30
The unique identifier of the menu item. -
RegistryName: string
Maximum Length:
30
The unique identifier of the menu. -
SeedDataLock: integer
(int32)
Default Value:
0
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.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorRegistryItemDefinitions-item-response
Type:
Show Source
object
-
Attributes: array
Menu Item Attributes
Title:
Menu Item Attributes
The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute. -
Configurations: array
Menu Item Configurations
Title:
Menu Item Configurations
The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
Maximum Length:
100
The full description of the menu item. -
DisplayMode: 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: string
Maximum Length:
30
The web application serves the target page of the menu link. -
ItemName: string
Maximum Length:
30
The unique identifier of the menu item. -
ItemType: 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: string
Maximum Length:
50
The short description of the menu item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ModuleId: string
Maximum Length:
32
The product feature area the menu item is associated with. -
ParentName: string
Maximum Length:
30
The unique identifier of the parent menu folder. -
RegistryName: string
Maximum Length:
30
The unique identifier of the menu. -
SecurityMode: 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: integer
(int32)
Default Value:
0
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: integer
(int32)
The sequence number of the menu item inside the parent menu folder.
-
TargetLocation: 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: 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: string
The target page URL of the menu link.
-
ValidFromDate: string
(date-time)
The start date when the menu item is displayed.
-
ValidToDate: 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 item attributes resource is used to view, create, modify, or delete a navigation menu item attribute.
Show Source
Nested Schema : Menu Item Configurations
Type:
array
Title:
Menu Item Configurations
The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRegistryItemDefinitions-Attributes-item-response
Type:
Show Source
object
-
AttributeId: string
Maximum Length:
30
The unique identifier of the menu item attribute. -
AttributeLongValue: string
The static long value of the menu item attribute.
-
AttributeShortValue: string
Maximum Length:
250
The static short value of the menu item attribute. -
AttributeStringValue: string
Maximum Length:
250
The label of the menu item attribute. -
AttributeTypeValue: string
Maximum Length:
4
The type value of the menu item attribute. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
Maximum Length:
30
The unique identifier of the menu item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RegistryName: string
Maximum Length:
30
The unique identifier of the menu. -
SeedDataLock: integer
(int32)
Default Value:
0
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorRegistryItemDefinitions-Configurations-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
The unique identifier of the agency that is associated with this menu item attribute customization data.
-
AttributeId: string
Maximum Length:
30
The unique identifier of the menu item attribute. -
AttributeLongValue: string
The static long value of the menu item attribute.
-
AttributeShortValue: string
Maximum Length:
250
The static short value of the menu item attribute. -
AttributeStringValue: string
Maximum Length:
250
The label of the menu item attribute. -
AttributeTypeValue: string
Maximum Length:
4
The type value of the menu item attribute. -
DeletedFlag: boolean
Maximum Length:
1
Default Value:false
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: string
Maximum Length:
30
The unique identifier of the menu item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RegistryName: string
Maximum Length:
30
The unique identifier of the menu. -
SeedDataLock: integer
(int32)
Default Value:
0
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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- Attributes
-
Parameters:
- publicSectorRegistryItemDefinitionsUniqID:
$request.path.publicSectorRegistryItemDefinitionsUniqID
The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute. - publicSectorRegistryItemDefinitionsUniqID:
- Configurations
-
Parameters:
- publicSectorRegistryItemDefinitionsUniqID:
$request.path.publicSectorRegistryItemDefinitionsUniqID
The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data. - publicSectorRegistryItemDefinitionsUniqID: