Visibility

Each object has a flag which indicates whether it is a hidden object or not. A UI consuming the API may choose to then display or hide the hidden objects. The primary purpose of this flag is to mark objects that should be considered as hidden internal data objects that help implement a larger data type. Because hidden objects are meant to represent internal objects, a UI consuming the API may choose to prompt the user as to whether linked hidden objects should always be cloned or removed from the project when the object containing the links is cloned or removed.

Because the visibility of the object is so closely tied to its type or its role in satisfying another object’s type, this flag can only be set on an object while it is still open. By default, all newly created objects are not hidden.

API method: /class-xxxx/setVisibility

Specification

Sets the visibility of the object.

Inputs

  • hidden boolean Whether the object is to be hidden or not

Outputs

  • id string ID of the manipulated object

Errors

  • ResourceNotFound (the specified object in the URL does not exist)
  • InvalidInput (the input is not a hash, hidden is not present or is not a boolean)
  • PermissionDenied (UPLOAD access required for the project in which the object was created)
  • InvalidState (the object is not in the "open" state)

Last edited by Thanh-Ha Nguyen, 2016-06-24 20:03:40

 Feedback