Sign in
Builder pages

Updates an existing page of an application builder

patch/api/builder/pages/{page_id}/

Path parameters

page_idinteger required

The id of the page

Headers

ClientSessionIdstring uuid

An optional header that marks the action performed by this request as having occurred in a particular client session. Then using the undo/redo endpoints with the same ClientSessionId header this action can be undone/redone.

Request body

namestring
pathstring
visibility'all' | 'logged-in'
  • all - All
  • logged-in - Logged In
role_type'allow_all' | 'allow_all_except' | 'disallow_all_except'
  • allow_all - Allow All
  • allow_all_except - Allow All Except
  • disallow_all_except - Disallow All Except
{"stackTrail":"components:schemas:PatchedUpdatePage:properties:roles","oasType":"schema","type":"unknown","description":"List of user roles that are associated with this page. Used in conjunction with role_type."}

Response

idinteger required
namestring required
pathstring required
orderinteger required

Lowest first.

builder_idinteger required
sharedboolean required
visibility'all' | 'logged-in' required
  • all - All
  • logged-in - Logged In
role_type'allow_all' | 'allow_all_except' | 'disallow_all_except' required
  • allow_all - Allow All
  • allow_all_except - Allow All Except
  • disallow_all_except - Disallow All Except
{"stackTrail":"components:schemas:Page:properties:roles","oasType":"schema","type":"unknown","description":"List of user roles that are associated with this page. Used in conjunction with role_type."}
{"stackTrail":"components:schemas:Page:properties:graph","oasType":"schema","type":"unknown","description":"A JSON serialized graph containing the points and edges."}

Changes

No recorded changes to this endpoint across all 6 revisions of this API.