Introduction

Subunit scopes allow to group subunits. Scopes define IDs of subunits that belong to them.

Also, for each subunit, the system maintains special read-only scope (marked with system: true attribute)
that is used to contain only this subunit (it has single subunit ID in subunit_ids)

SubunitScope Model

Example

{
  "subunit_scope": {
    "id": 3,
    "name": "Le Mall",
    "subunit_ids": [1],
    "created_at": "2022-01-26T16:47:00.696Z",
    "updated_at": "2022-01-26T16:47:00.696Z",
    "archived_at": null,
  }
}

Definition

Key	Type	Description
id	integer	(readonly)
name	string
subunit_ids	integer[]
system	boolean	(readonly) Is the scope maintained by system?
created_at	datetime	(readonly) Time of creation
updated_at	datetime	(readonly) Time of last update
archived_at	datetime	(readonly) Time of (soft) delete

SubunitScope Model#

Example#

Definition#

SubunitScope Model

Example

Definition