Configuration

Create an organisation property definition.

Changed on
put/configure/organisation

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/configure/organisation
  • Auth: API key in header ITB_API_KEY

Request body

keystring required

The unique key used to identify the property.

namestring

The property's name. If not set this will be the same as the property's key.

descriptionstring

The property's description.

requiredboolean

Whether the property must be set before executing test sessions.

editableByUsersboolean

Whether the property can be set by organisation users.

inTestsboolean

Whether the property should be exposed to test sessions.

inExportsboolean

Whether the property should be included in exports.

inSelfRegistrationboolean

Whether the property should be requested during self-registration.

hiddenboolean

Whether the property should be hidden from organisation users.

displayOrdernumber

The display order of the property when presented to users.

dependsOnstring

The key of another property upon which this property's applicability depends on (see also dependsOnValue).

dependsOnValuestring

If the dependsOn property is set, this is the value that the referred-to property needs to have for this property to be considered applicable.

defaultValuestring

The default value of the property when a new organisation is created.

kind'SIMPLE' | 'BINARY' | 'SECRET'

The property's value type. Presets (allowedValues) and defaultValue only apply to properties of type SIMPLE. Defaults to SIMPLE when creating a property, and is left unchanged when omitted on an update.

Response

Property created.

Changes

    • info

      added the new optional request property

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status