Workspace properties

Attach your own metadata to a workspace as a JSON object, readable through the REST API.

Workspace properties hold additional metadata about a workspace as a free-form JSON object. The object is available through the REST API, which makes it a useful place to keep information your own applications and integrations need to read alongside the workspace.

Typical uses are describing the site a workspace represents, recording identifiers from another system such as an ERP or IWMS, or storing configuration that a feature or an integration of yours reads at runtime.

Editing the object

Open Workspace properties on the General settings page, edit the JSON in the editor, and select Save settings. The content must be a single valid JSON object.

{
  "onboardingConfig": {
    "spatialModelUrl": "https://example.com/spatial-model.json"
  }
}

Some akenza features read their own configuration from a reserved key in this object. The onboardingConfig key shown above is one such example, pointing at a spatial model used during device onboarding.

The editor replaces the whole object, so an application that writes here through the API and a person editing in the UI can overwrite each other. Read the current value before writing a new one, and keep keys that belong to other consumers intact.

Workspace properties describe the workspace. To attach structured information to individual devices, use custom fields instead, which are searchable and can be shown as columns in the asset inventory.