Sign in
menuBoard

Search Menu Board Categories

Search all Menu Boards Categories this user has access to

get/menuboard/{menuId}/categories

Path parameters

menuIdinteger required

Filter by Menu board Id

Query parameters

menuCategoryIdinteger

Filter by Menu Board Category Id

namestring

Filter by name

codestring

Filter by code

sortBy'menuCategoryId' | 'name' | 'code'

Specifies which field the results are sorted by. Used together with sortDir

sortDir'asc' | 'desc'

Sort direction

Response

successful operation

{"stackTrail":"components:schemas:MenuBoard:properties:menuId","oasType":"schema","type":"unknown","description":"The Menu Board Id"}
{"stackTrail":"components:schemas:MenuBoard:properties:name","oasType":"schema","type":"unknown","description":"The Menu Board name"}
{"stackTrail":"components:schemas:MenuBoard:properties:description","oasType":"schema","type":"unknown","description":"The Menu Board description"}
{"stackTrail":"components:schemas:MenuBoard:properties:code","oasType":"schema","type":"unknown","description":"The Menu Board code identifier"}
{"stackTrail":"components:schemas:MenuBoard:properties:userId","oasType":"schema","type":"unknown","description":"The Menu Board owner Id"}
{"stackTrail":"components:schemas:MenuBoard:properties:modifiedDt","oasType":"schema","type":"unknown","description":"The Menu Board last modified date"}
{"stackTrail":"components:schemas:MenuBoard:properties:folderId","oasType":"schema","type":"unknown","description":"The Id of the Folder this Menu Board belongs to"}
{"stackTrail":"components:schemas:MenuBoard:properties:permissionsFolderId","oasType":"schema","type":"unknown","description":"The id of the Folder responsible for providing permissions for this Menu Board"}
{"stackTrail":"components:schemas:MenuBoard:properties:groupsWithPermissions","oasType":"schema","type":"unknown","description":"A comma separated list of Groups/Users that have permission to this menu Board"}

Changes

Changed in 5 of the 52 revisions of this API.105

  • fe497e811c7f92See the full diff
    • ▲

      the items/code response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/description response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/folderId response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/groupsWithPermissions response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/menuId response's property type/format changed from integer/ to / for status 200

      response-property-type-changed

    • ▲

      the items/modifiedDt response's property type/format changed from integer/ to / for status 200

      response-property-type-changed

    • ▲

      the items/name response's property type/format changed from string/ to / for status 200

      response-property-type-changed

    • ▲

      the items/permissionsFolderId response's property type/format changed from integer/ to / for status 200

      response-property-type-changed

    • ▲

      the items/userId response's property type/format changed from integer/ to / for status 200

      response-property-type-changed

    • ○

      added the new optional query request parameter sortBy

      new-optional-request-parameter

    • ○

      added the new optional query request parameter sortDir

      new-optional-request-parameter

  • 41c04de98ec51See the full diff
    • ○

      added the media type application/json for the response with the status 200

      response-media-type-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6d18f62f77821See the full diff
    • ○

      added the new optional query request parameter code

      new-optional-request-parameter

  • 23e8e640f5241See the full diff
    • ○

      endpoint added

      endpoint-added

  • 8e12753951041See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog