ZRM Docs
Domain Model

Workspace

Fields

FieldTypeRequiredDefaultDescription
idstring.uuidYesId
createdAtstring.date-timeYesCreated at
updatedAtstring.date-timeYesUpdated at
namestringYesName
keystringYesKey
descriptionstringNoDescription
workspaceTypeenum(master, standard, template_based, archived)YesWorkspace type
statusenum(active, archived)YesStatus
parentWorkspaceIdstringNoID of the associated parent workspace
createdBystringNoCreated by
archivedAtstring.date-timeNoArchived at
archivedBystringNoArchived by

Create Schema

Fields accepted when creating a new record:

FieldTypeRequiredDefaultDescription
namestringYesName
keystringYesKey
descriptionstringNoDescription
workspaceTypeenum(master, standard, template_based, archived)Yes"standard"Workspace type
statusenum(active, archived)Yes"active"Status
parentWorkspaceIdstringNoID of the associated parent workspace
createdBystringNoCreated by
archivedAtstring.date-timeNoArchived at
archivedBystringNoArchived by

Update Schema

All fields are optional when updating:

FieldTypeRequiredDefaultDescription
namestringNoName
keystringNoKey
descriptionstringNoDescription
statusenum(active, archived)No"active"Status
parentWorkspaceIdstringNoID of the associated parent workspace
createdBystringNoCreated by
archivedAtstring.date-timeNoArchived at
archivedBystringNoArchived by

On this page