v13

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-051528661.3 MB
Model Objects

Upsert

put/landscapes/{landscapeId}/versions/{versionId}/model/objects/{modelObjectId}

Path parameters

landscapeIdstring required
versionIdstring required
modelObjectIdstring required

Request body

captionstring

Short summary of the object shown as the display description

commitnumber
descriptionstring
externalboolean
groupIdsstring[]

IDs of the groups this model object belongs to

labelsobject

Generic key value store used for creating custom integrations

namestring required
parentIdstring nullable required

Parent model object ID, null for the root level model object

status'deprecated' | 'future' | 'live' | 'removed'
tagIdsstring[]

Tag IDs assigned to this model

teamIdsstring[]

Team IDs that own this model object, does not propergate up or down

teamOnlyEditingboolean

Model object (+child diagram, diagram groups and flows) can only be edited by owners and admins

technologyIdsstring[]

Technology ids assigned to this model

type'actor' | 'app' | 'component' | 'group' | 'root' | 'store' | 'system' required
domainIdstring
handleIdstring

Response

OK