Jump to

• Request
• Response

Get all menu items

get

/fscmRestApi/resources/11.13.18.05/publicSectorRegistryItemDefinitions

Request

Query Parameters

• 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 fields. Only the specified fields are returned, which means that if no fields are specified, no fields 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 fields. 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:
  
  

  • 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:
    • value; string; The keyword to search in the name, label, or description of menu items.
• 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.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• 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 fields. 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
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • DeletedFlag; boolean; 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; The full description of the menu item.
  • DisplayMode; string; 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; The web application serves the target page of the menu link.
  • ItemName; string; The unique identifier of the menu item.
  • ItemType; string; 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; The short description of the menu item.
  • ModuleId; string; The product feature area the menu item is associated with.
  • ParentName; string; The unique identifier of the parent menu folder.
  • RegistryName; string; The unique identifier of the menu.
  • SecurityMode; string; 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; 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; The sequence number of the menu item inside the parent menu folder.
  • TargetLocation; string; 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; 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.
  • ValidFromDate; string; The start date when the menu item is displayed.
  • ValidToDate; string; The end date when the menu item is displayed.
• 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".

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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : publicSectorRegistryItemDefinitions

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  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: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRegistryItemDefinitions-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"SharedServices",
        "usage":"BusinessObject",
        "group":"psc"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorRegistryItemDefinitions-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRegistryItemDefinitions-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorRegistryItemDefinitions-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ValidToDate":{
            "type":"string",
            "description":"The end date when the menu item is displayed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":"100",
            "type":"string",
            "description":"The full description of the menu item.",
            "nullable":false,
            "x-queryable":true
        },
        "ItemType":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the menu item is a menu folder or menu link. Valid values are F for menu folder, and L for menu link.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "Label":{
            "maxLength":"50",
            "type":"string",
            "description":"The short description of the menu item.",
            "nullable":false,
            "x-queryable":true
        },
        "Attributes":{
            "title":"Menu Item Attributes",
            "type":"array",
            "description":"The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRegistryItemDefinitions-Attributes-item-response"
            }
        },
        "ParentName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the parent menu folder.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetUri":{
            "type":"string",
            "description":"The target page URL of the menu link.",
            "nullable":true,
            "x-queryable":false
        },
        "DisplayMode":{
            "maxLength":"4",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ModuleId":{
            "maxLength":"32",
            "type":"string",
            "description":"The product feature area the menu item is associated with.",
            "nullable":false,
            "x-queryable":true
        },
        "SecurityMode":{
            "maxLength":"1",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetLocation":{
            "maxLength":"4",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "RegistryName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu.",
            "nullable":false,
            "x-queryable":true
        },
        "SequenceNumber":{
            "type":"integer",
            "description":"The sequence number of the menu item inside the parent menu folder.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"4"
            },
            "x-queryable":true
        },
        "ValidFromDate":{
            "type":"string",
            "description":"The start date when the menu item is displayed.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "TargetType":{
            "maxLength":"4",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Configurations":{
            "title":"Menu Item Configurations",
            "type":"array",
            "description":"The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRegistryItemDefinitions-Configurations-item-response"
            }
        },
        "HostName":{
            "maxLength":"30",
            "type":"string",
            "description":"The web application serves the target page of the menu link.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

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

• Array of: object publicSectorRegistryItemDefinitions-Attributes-item-response

{
    "title":"Menu Item Attributes",
    "type":"array",
    "description":"The menu item attributes resource is used to view, create, modify, or delete a navigation menu item attribute.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRegistryItemDefinitions-Attributes-item-response"
    }
}

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

• Array of: object publicSectorRegistryItemDefinitions-Configurations-item-response

{
    "title":"Menu Item Configurations",
    "type":"array",
    "description":"The menu item configurations resource is used to view, create, modify, or delete a navigation item customer configuration data.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRegistryItemDefinitions-Configurations-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorRegistryItemDefinitions-Attributes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":"4",
            "type":"string",
            "description":"The type value of the menu item attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the menu item attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "AttributeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RegistryName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeStringValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The label of the menu item attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeShortValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The static short value of the menu item attribute.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Nested Schema : publicSectorRegistryItemDefinitions-Configurations-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "AttributeTypeValue":{
            "maxLength":"4",
            "type":"string",
            "description":"The type value of the menu item attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeLongValue":{
            "type":"string",
            "description":"The static long value of the menu item attribute.",
            "nullable":true,
            "x-queryable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The unique identifier of the agency that is associated with this menu item attribute customization data.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "AttributeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item attribute.",
            "nullable":false,
            "x-queryable":true
        },
        "SeedDataLock":{
            "type":"integer",
            "description":"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.",
            "format":"int32",
            "nullable":false,
            "default":"0",
            "x-hints":{
                "precision":"1"
            },
            "x-queryable":true
        },
        "RegistryName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu.",
            "nullable":false,
            "x-queryable":true
        },
        "AttributeStringValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The label of the menu item attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "DeletedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ItemName":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier of the menu item.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttributeShortValue":{
            "maxLength":"250",
            "type":"string",
            "description":"The static short value of the menu item attribute.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Back to Top