Headers

• X-Gatego-oid

  Specify effective organization_id for Admin and Group Organization Admins. This is a global header for all endpoints only taken into consideration when it makes sense (it won't be used in Auth, for example)

Responses

• 200 */*

  OK

  Hide response attributes Show response attributes object

  • effective_value object

    The effective value of the setting property

    Hide effective_value attributes Show effective_value attributes object

    • level string

      Values are ACCOUNT, GLOBAL, ORGANIZATION, or YARD.

    • multi_value array[object]

      An array of values per each level identifier. Only present when this level might have several values for the same setting and level, for example for level YARD, each element will represent the value at each yard identifier. In this case, the field level_id will be the identifier of the yard

      Hide multi_value attributes Show multi_value attributes object

      • level_id integer(int64)

        The ID of the level. Eg. the the yard ID, the account ID, etc

      • value object
    • value object
  • levels array[object]

    Values at each level

    Hide levels attributes Show levels attributes object

    • level string

      Values are ACCOUNT, GLOBAL, ORGANIZATION, or YARD.

    • multi_value array[object]

      An array of values per each level identifier. Only present when this level might have several values for the same setting and level, for example for level YARD, each element will represent the value at each yard identifier. In this case, the field level_id will be the identifier of the yard

      Hide multi_value attributes Show multi_value attributes object

      • level_id integer(int64)

        The ID of the level. Eg. the the yard ID, the account ID, etc

      • value object
    • value object
  • name string

    The unique name of the setting property

  • options object
  • stop_override_level string

    Level at which the setting's override is stopped. Eg. if set to ACCOUNT, the effective value of a property that is set in the ORGANIZATION, YARD and ACCOUNT levels, will be the one at ACCOUNT. However if the stop_override_level is set to YARD, it won't be possible to override at ACCOUNT level

    Values are ACCOUNT, GLOBAL, ORGANIZATION, or YARD.

  • type string

    The type of the property

    Values are BOOLEAN, CHOICE, JSON, NUMBER, or STRING.

  • write_permission_level string

    The permissions level for writing to the property setting. Eg. if set to ORG_ADMIN, then GUARDS won't be able to set the value of this property

    Values are ALL, GLOBAL_ADMIN, or ORG_ADMIN.

• 401

  Unauthorized

• 403

  Forbidden

• 404

  Not Found