API · v1 · stabil
CODEMETA OSDeveloper Center
Konsole öffnen
Entity · assets

Asset Schema

Schema-ID
asset
Collection
assets
Permissions
  • Lesenasset_view
  • Anlegenasset_create
  • Ändernasset_edit
  • Löschenasset_delete

Felder

Asset Schema

assets4 Permissions

Schema for validating asset entities

namestringoptional

Asset name. Optional — peripherals and small items often do not have a meaningful name; identification then happens via manufacturer + model + serialNumber.

max 200 Zeichennullable
statusstringerforderlich

Asset status

ACTIVEINACTIVERETIREDIN_REPAIRORDERED
partyIduuidoptional

Associated party UUID

nullable
partyAddressIduuidoptional

Specific site/address of the associated party

Default: nullnullable
locationIduuidoptional

Reference to a Location entity (e.g. specific room at the site)

Default: nullnullable
rackStartUnitintegeroptional

Starting rack unit (HE) position, 1-based from bottom

≥ 1Default: nullnullable
rackHeightUnitsintegeroptional

Number of rack units (HE) this asset occupies

1 – 48Default: nullnullable
rackSidestringoptional

Which side of the rack the asset is mounted on

FRONTREARnull
Default: nullnullable
assetTemplateIduuidoptional

Reference to an asset_template (device type library) — inherits dimensions + port layout

Default: nullnullable
contactPartyIduuidoptional

Associated contact person UUID

nullable
notesstringoptional

Free-text notes or description

max 5000 Zeichennullable
locationDescriptionstringoptional

Physical location description

max 500 Zeichennullable
serialNumberstringoptional

Serial number

max 100 Zeichennullable
manufacturerstringoptional

Manufacturer name

max 100 Zeichennullable
modelstringoptional

Model name

max 100 Zeichennullable
eanstringoptional

EAN / GTIN barcode (e.g. imported from weclapp article)

max 14 Zeichennullable
manufacturerPartNumberstringoptional

Manufacturer part number / MPN (Hersteller-Teilenummer)

max 100 Zeichennullable
customsTariffNumberstringoptional

Customs tariff number / HS code (Zolltarifnummer)

max 20 Zeichennullable
weightnumberoptional

Net weight in kilograms (Nettogewicht, e.g. from weclapp article)

≥ 0nullable
grossWeightnumberoptional

Gross weight in kilograms (Bruttogewicht, e.g. from weclapp article)

≥ 0nullable
lengthnumberoptional

Length in meters (Länge, e.g. from weclapp article)

≥ 0nullable
widthnumberoptional

Width in meters (Breite)

≥ 0nullable
heightnumberoptional

Height in meters (Höhe)

≥ 0nullable
unitstringoptional

Base unit (Grundeinheit, e.g. "Stk." from weclapp article)

max 20 Zeichennullable
countryOfOriginstringoptional

Country of origin (Ursprungsland, ISO code or name)

max 100 Zeichennullable
purchaseDatedateoptional

Purchase date in YYYY-MM-DD format

nullable
warrantyExpiresAtdatetimeoptional

Warranty expiration date

nullable
purchasePricenumberoptional

Purchase price (Einkaufspreis) in EUR

≥ 0nullable
salesPricenumberoptional

Sales price (Verkaufspreis) in EUR

≥ 0nullable
contractIduuidoptional

Associated contract UUID

nullable
tagsstring[]optional

Asset tags

Default: []nullable
imageFileIdsstring[]optional

File IDs of asset photos

Default: []
linkedEntitiesobject[]optional
Default: []nullable
entityTypestringerforderlich
partyassetticketcontractprojectuseropportunity
entityIduuiderforderlich
rolestringerforderlich
ipAddressipv4optional

IP address for endpoint assets

nullable
macAddressstringoptional

MAC address for endpoint assets

Patternnullable
hostnamestringoptional

Hostname for endpoint assets

max 253 Zeichennullable
dynDnsstringoptional

Dynamic DNS hostname for endpoint assets

max 253 Zeichennullable
networksobject[]optional

Network interfaces (IP, MAC, hostname per interface)

Default: []nullable
iduuiderforderlich

Unique network interface identifier (UUIDv7)

labelstringoptional

Network label (e.g. LAN, WLAN, Management)

max 100 Zeichennullable
ipAddressipv4optional

IPv4 address

nullable
macAddressstringoptional

MAC address

Patternnullable
hostnamestringoptional

Hostname

max 253 Zeichennullable
roomstringoptional

Room or physical location within the building

max 200 Zeichennullable
serviceUserIduuidoptional

Assigned service technician (user UUID)

nullable
inventoryNumberstringoptional

Internal inventory number

max 100 Zeichennullable
ownershipTypestringoptional

Whether the device is company-owned or external

OWNEXTERNAL
nullable
teamviewerDeviceIdstringoptional

TeamViewer device ID (from sync)

max 100 Zeichennullable
teamviewerRemoteControlIdstringoptional

TeamViewer remote control ID (rXXXXXXXXX)

max 100 Zeichennullable
anydeskIdstringoptional

AnyDesk ID for remote access

max 100 Zeichennullable
agentIduuidoptional

Bound desktop agent machine ID (UUIDv7)

nullable
agentStatusstringoptional

Agent connection status

ONLINEOFFLINESTALEUNREGISTERED
nullable
agentLastSeenAtdatetimeoptional

Last heartbeat timestamp from agent

nullable
agentVersionstringoptional

Desktop agent software version

max 20 Zeichennullable
agentPoolbooleanoptional

True if auto-enrolled and not yet assigned to a party

nullable
primaryUserNamestringoptional

OS account name of the currently logged-in user (e.g. sAMAccountName)

max 100 Zeichennullable
primaryUserDomainstringoptional

NETBIOS / AD domain of the logged-in user

max 100 Zeichennullable
primaryUserDisplayNamestringoptional

Display name of the logged-in user (e.g. "John Doe")

max 200 Zeichennullable
primaryUserEmailstringoptional

Email/UPN of the logged-in user (used to auto-link to a Person party)

max 200 Zeichennullable
primaryUserUpnstringoptional

User principal name from Windows AAD/AD (user@tenant.tld)

max 200 Zeichennullable
primaryUserPartyIduuidoptional

Party UUID auto-resolved from primaryUserEmail. Set by the agent heartbeat handler on email match; cleared when the email no longer matches.

nullable
primaryUserUpdatedAtdatetimeoptional

Timestamp of the last primaryUser change (for audit / staleness detection)

nullable
agentPrintersobject[]optional

Printers reported by a print-capable agent (ADR 0321).

nullable
idstringerforderlich
max 200 Zeichen
namestringerforderlich
max 200 Zeichen
driverstringoptional
max 200 Zeichennullable
connectionstringoptional
max 200 Zeichennullable
isDefaultbooleanoptional
nullable
mediaWidthMmnumberoptional
nullable
mediaHeightMmnumberoptional
nullable
statusstringoptional
max 100 Zeichennullable
dependsOnuuid[]optional

Upstream asset-IDs this asset depends on. Open incidents on any upstream suppress new child-incidents until the parent resolves (cascade-unsuppress).

max 32 Itemsnullable
probeobjectoptional

Probe-Agent configuration (ADR 0061)

nullable
enabledbooleanoptional
networksstring[]optional

CIDR ranges this probe is responsible for

max 32 Items
maxTargetsintegeroptional
1 – 100000nullable
osEditionstringoptional

OS edition (e.g. Windows 11 Pro)

max 100 Zeichennullable
osBuildstringoptional

OS build number

max 50 Zeichennullable
osArchitecturestringoptional

OS architecture

x86x64arm64
nullable
lastBootTimedatetimeoptional

Last system boot time (from agent inventory)

nullable
biosVendorstringoptional

BIOS vendor name

max 100 Zeichennullable
biosVersionstringoptional

BIOS version string

max 100 Zeichennullable
chassisTypestringoptional

Physical chassis type (auto-detected by agent)

DESKTOPLAPTOPSERVERTABLETMINI_PCALL_IN_ONEOTHER
nullable
totalRamGbnumberoptional

Total installed RAM in GB (from agent inventory)

≥ 0nullable
tpmVersionstringoptional

TPM spec version (e.g. "2.0"), null if absent/not reported

max 20 Zeichennullable
licenseKeystringoptional

License key for software assets

nullable
seatsintegeroptional

Number of license seats

≥ 1nullable
expiresAtdatetimeoptional

License expiration date

nullable
criticalitystringoptional

Asset criticality for business operations

LOWMEDIUMHIGHCRITICAL
nullable
rtonumberoptional

Recovery Time Objective in hours

≥ 0nullable
rponumberoptional

Recovery Point Objective in hours

≥ 0nullable
businessImpactstringoptional

Description of business impact if asset is unavailable

max 2000 Zeichennullable
downtimeCostPerHournumberoptional

Estimated cost per hour of downtime

≥ 0nullable
redundancyTypestringoptional

Redundancy configuration

NONEACTIVE_PASSIVEACTIVE_ACTIVEN_PLUS_1CLUSTER
nullable
emergencyContactstringoptional

Emergency contact information

max 500 Zeichennullable
recoveryNotesstringoptional

Recovery procedure notes

max 5000 Zeichennullable
vendorstringoptional

Software vendor name

max 200 Zeichennullable
appVersionstringoptional

Application version

max 50 Zeichennullable
deploymentTypestringoptional

Deployment type

ON_PREMISECLOUDHYBRIDSAAS
nullable
urlstringoptional

Application or website URL

max 2000 Zeichennullable
processOwnerstringoptional

Process owner name or role

max 200 Zeichennullable
frequencystringoptional

How often the process runs

CONTINUOUSDAILYWEEKLYMONTHLYQUARTERLYYEARLYON_DEMAND
nullable
inputSystemsstring[]optional

Systems providing input to this process

nullable
outputSystemsstring[]optional

Systems receiving output from this process

nullable
hostingProviderstringoptional

Hosting provider name

max 200 Zeichennullable
sslExpiresAtdatetimeoptional

SSL certificate expiration date

nullable
cmsstringoptional

Content management system

max 100 Zeichennullable
monitoringUrlstringoptional

Monitoring dashboard URL

max 2000 Zeichennullable
cloudProviderstringoptional

Cloud service provider

AWSAZUREGCPHETZNEROTHER
nullable
serviceTypestringoptional

Type of cloud service (e.g. IaaS, PaaS, SaaS)

max 100 Zeichennullable
regionstringoptional

Cloud region or data center location

max 50 Zeichennullable
accountIdstringoptional

Cloud account identifier

max 100 Zeichennullable
monthlyBudgetnumberoptional

Monthly budget for this cloud service

≥ 0nullable
dbEnginestringoptional

Database engine (e.g. PostgreSQL, MySQL, MongoDB)

max 100 Zeichennullable
dbVersionstringoptional

Database version

max 50 Zeichennullable
sizeGbnumberoptional

Database size in GB

≥ 0nullable
backupSchedulestringoptional

Backup schedule (e.g. cron expression or description)

max 200 Zeichennullable
replicationModestringoptional

Database replication mode

NONEPRIMARY_REPLICAMULTI_MASTERCLUSTER
nullable
backupTypestringoptional

Backup strategy type

FULLINCREMENTALDIFFERENTIALSNAPSHOT
nullable
retentionDaysintegeroptional

Backup retention period in days

≥ 1nullable
targetStoragestringoptional

Target storage location for backups

max 500 Zeichennullable
lastBackupAtdatetimeoptional

Last successful backup timestamp

nullable
schedulestringoptional

Backup or sync schedule

max 200 Zeichennullable
commTypestringoptional

Communication system type

EMAILPHONECHATVIDEOFAX
nullable
providerstringoptional

Service provider

max 200 Zeichennullable
userCountintegeroptional

Number of users on this system

≥ 0nullable
domainNamestringoptional

Fully qualified domain name

max 253 Zeichennullable
registrarstringoptional

Domain registrar name

max 200 Zeichennullable
domainExpiresAtdatetimeoptional

Domain registration expiry date

nullable
autoRenewbooleanoptional

Whether domain auto-renews

nullable
renewalModestringoptional

INWX renewal mode. AUTOEXPIRE = scheduled for expiry at period end (cancelled by user).

AUTORENEWAUTOEXPIREAUTODELETERENEWONCE
nullable
cancelledAtdatetimeoptional

Timestamp when the domain was scheduled for cancellation (set to AUTOEXPIRE)

nullable
cancelledBystringoptional

User ID who scheduled the cancellation

nullable
lastDnsScoreintegeroptional

Most recent DNS health score (0–100)

0 – 100nullable
dnsReportobjectoptional

Embedded DNS report with records, checks, score, and recommendations

nullable
nameserversstring[]optional

Nameserver hostnames (e.g. ns.inwx.de)

max 10 Itemsnullable
useInwxNameserversbooleanoptional

Whether DNS is managed via INWX nameservers

nullable
inwxDomainIdintegeroptional

INWX domain ID for synchronization

nullable
inwxSyncStatusstringoptional

Current INWX synchronization status

syncedsyncingconflicterror
nullable
lastSyncAtdatetimeoptional

Timestamp of last successful INWX sync

nullable
ownerPartyIduuidoptional

Party used as INWX owner handle

nullable
adminPartyIduuidoptional

Party used as INWX admin handle

nullable
techPartyIduuidoptional

Party used as INWX tech handle

nullable
billingPartyIduuidoptional

Party used as INWX billing handle

nullable
transferStatusstringoptional

Domain transfer status

nonependingin_progresscompletedfailed
nullable
transferLockbooleanoptional

Whether the domain transfer lock is enabled

nullable
whoisPrivacybooleanoptional

Whether WHOIS privacy protection is enabled

nullable
dnssecEnabledbooleanoptional

Whether DNSSEC is enabled for this domain

nullable
dnssecDataobjectoptional

DNSSEC DS record data

nullable
keyTagintegeroptional
algorithmintegeroptional
digestTypeintegeroptional
digeststringoptional
max 500 Zeichen
subnetstringoptional

Subnet in CIDR notation (e.g. 192.168.1.0/24)

max 50 Zeichennullable
vlanIdintegeroptional

VLAN ID (1-4094)

1 – 4094nullable
gatewaystringoptional

Default gateway IP address

max 50 Zeichennullable
networkTypestringoptional

Network type classification

LANWLANWANVPNDMZVLANSD_WANOTHER
nullable
peripheralDeviceTypestringoptional

Peripheral device type category

MONITORKEYBOARDMOUSEHEADSETWEBCAMDOCKING_STATIONUPSPROJECTORSCANNEREXTERNAL_STORAGEKVM_SWITCHPRINTERLABEL_PRINTEROTHER
nullable
articleNumberstringoptional

Manufacturer article/part number

max 100 Zeichennullable
peripheralTypestringoptional

Connection or technology type (e.g. USB-C, Bluetooth, DECT)

max 200 Zeichennullable
hypervisorAssetIduuidoptional

Reference to the host server asset (hypervisor)

nullable
hypervisorTypestringoptional

Hypervisor platform — on servers: editable source of truth; on VMs: denormalized from linked server (read-only in UI)

VMWARE_ESXIHYPER_VPROXMOXKVMXEN
nullable
vCpuintegeroptional

Number of virtual CPUs

≥ 1nullable
ramGbnumberoptional

Allocated RAM in GB

≥ 0nullable
diskGbnumberoptional

Allocated disk space in GB

≥ 0nullable
guestOsstringoptional

Guest operating system

max 200 Zeichennullable
vmIdstringoptional

Hypervisor-internal VM identifier (e.g. VMware BIOS UUID)

max 200 Zeichennullable
clusterNamestringoptional

Cluster name (ESXi/Hyper-V cluster or Kubernetes cluster)

max 200 Zeichennullable
datastoreNamestringoptional

Datastore or storage volume name

max 200 Zeichennullable
haEnabledbooleanoptional

Whether high availability is enabled

nullable
snapshotCountintegeroptional

Number of VM snapshots

≥ 0nullable
mobileDeviceTypestringoptional

Mobile device type

SMARTPHONETABLET
nullable
imeistringoptional

IMEI (International Mobile Equipment Identity)

max 20 Zeichennullable
meidstringoptional

MEID (Mobile Equipment Identifier)

max 20 Zeichennullable
simNumberstringoptional

SIM card number (ICCID)

max 30 Zeichennullable
phoneNumberstringoptional

Phone number

max 30 Zeichennullable
carrierstringoptional

Mobile carrier / provider

max 100 Zeichennullable
osNamestringoptional

Operating system name (e.g. iOS, Android)

max 50 Zeichennullable
osVersionstringoptional

Operating system version

max 30 Zeichennullable
mdmEnrolledbooleanoptional

Whether the device is enrolled in MDM

nullable
mdmProviderstringoptional

MDM provider (e.g. Intune, Jamf, MobileIron)

max 100 Zeichennullable
screenLockPolicystringoptional

Screen lock policy (e.g. PIN, Biometric)

max 100 Zeichennullable
encryptionEnabledbooleanoptional

Whether device encryption is enabled

nullable
storageTypestringoptional

Storage system type

SANNASDASOBJECT_STORAGE
nullable
totalCapacityGbnumberoptional

Total storage capacity in GB

≥ 0nullable
usedCapacityGbnumberoptional

Used storage in GB

≥ 0nullable
raidLevelstringoptional

RAID level

RAID_0RAID_1RAID_5RAID_6RAID_10RAID_Z1RAID_Z2NONE
nullable
protocolsstring[]optional

Supported storage protocols

nullable
lunCountintegeroptional

Number of LUNs (Logical Unit Numbers)

≥ 0nullable
shareCountintegeroptional

Number of network shares

≥ 0nullable
ssidsstring[]optional

Broadcast SSIDs

nullable
frequencyBandstringoptional

Supported frequency band

2_4GHZ5GHZ6GHZDUAL_BANDTRI_BAND
nullable
wlanStandardstringoptional

WLAN standard (e.g. 802.11ax, Wi-Fi 6E)

max 50 Zeichennullable
channelintegeroptional

Radio channel

1 – 233nullable
channelWidthintegeroptional

Channel width in MHz

204080160
nullable
controllerAssetIduuidoptional

Reference to the WLAN controller asset

nullable
poeEnabledbooleanoptional

Whether PoE (Power over Ethernet) is enabled

nullable
maxClientsintegeroptional

Maximum number of connected clients

≥ 0nullable
portCountintegeroptional

Total number of physical ports on the switch

≥ 0nullable
uplinkPortCountintegeroptional

Number of SFP/uplink ports

≥ 0nullable
switchManagedstringoptional

Management type of the switch

MANAGEDSMARTUNMANAGED
nullable
switchLayerstringoptional

Switching layer (L2, L2+, L3)

L2L2_PLUSL3
nullable
poeSupportstringoptional

PoE support level (802.3af / 802.3at / 802.3bt)

NONEPOEPOE_PLUSPOE_PLUS_PLUS
nullable
poeBudgetWattsintegeroptional

Total PoE power budget in watts

≥ 0nullable
stackablebooleanoptional

Whether this is a stackable switch

nullable
stackMasterAssetIduuidoptional

Reference to the stack master asset

nullable
orchestratorTypestringoptional

Container orchestrator platform

KUBERNETESDOCKER_SWARMOPENSHIFTNOMADOTHER
nullable
k8sVersionstringoptional

Kubernetes / orchestrator version

max 30 Zeichennullable
nodeCountintegeroptional

Number of cluster nodes

≥ 0nullable
registryUrlstringoptional

Container registry URL

max 500 Zeichennullable
environmentstringoptional

Deployment environment

DEVSTAGINGPROD
nullable
totalCpuCoresintegeroptional

Total CPU cores across all nodes

≥ 0nullable
clusterTotalRamGbnumberoptional

Total RAM across all nodes in GB

≥ 0nullable
namespaceCountintegeroptional

Number of namespaces

≥ 0nullable
pbxTypestringoptional

PBX deployment type

ON_PREMISECLOUDHYBRID
nullable
pbxVendorstringoptional

PBX vendor (e.g. 3CX, Starface, Auerswald)

max 100 Zeichennullable
extensionCountintegeroptional

Number of extensions / Nebenstellen

≥ 0nullable
maxConcurrentCallsintegeroptional

Maximum concurrent calls

≥ 0nullable
sipProviderstringoptional

SIP trunk provider

max 200 Zeichennullable
sipTrunkCountintegeroptional

Number of SIP trunks

≥ 0nullable
didRangestringoptional

DID number range (e.g. +49 656 169944-0 to -99)

max 200 Zeichennullable
srtpEnabledbooleanoptional

Whether SRTP (Secure RTP) is enabled

nullable
codecSupportstring[]optional

Supported audio codecs (e.g. G.711, G.729, Opus)

nullable
callRecordingEnabledbooleanoptional

Whether call recording is enabled

nullable
repairStartedAtdatetimeoptional

Timestamp when repair started (auto-set on transition to IN_REPAIR)

nullable
repairCompletedAtdatetimeoptional

Timestamp when repair was completed (auto-set on transition from IN_REPAIR)

nullable
repairNotesstringoptional

Repair notes (initial diagnosis, visible damage, etc.)

max 5000 Zeichennullable
repairTicketIduuidoptional

Quick-link to the associated repair ticket

nullable
intakeReceivedAtdatetimeoptional

Timestamp when the device was received at intake (Annahmezeitpunkt)

nullable
intakeReceivedByuuidoptional

User who accepted the device at intake (Annahme durch)

nullable
intakeAccessoriesstring[]optional

Accessories / included items handed in with the device (Zubehör)

Default: []
intakeConditionstringoptional

Documented condition at intake (visible damage, scratches, etc.)

max 5000 Zeichennullable
intakePhotoFileIdsstring[]optional

File IDs of condition photos taken at intake (separate from imageFileIds)

Default: []
intakeSignatureFileIdstringoptional

File ID of the customer signature PNG captured at intake

nullable
storageLocationstringoptional

Free-text physical storage slot/shelf (Regal-/Stellplatz); distinct from room

max 200 Zeichennullable
intakeStagestringoptional

Repair-intake lifecycle stage driving the Warenannahme board; separate from the CMDB status (legacy docs derive it from status at runtime)

RECEIVEDIN_REPAIRREADY_FOR_PICKUPPICKED_UP
nullable
pickupDueAtdatetimeoptional

Planned pickup date for the repair device (mirrored from the repair ticket)

nullable
linkedRiskIdsstring[]optional

Linked risk IDs

Default: []
linkedTomIdsstring[]optional

Linked TOM IDs

Default: []
componentsobject[]optional

Internal hardware components (RAM, CPU, HDD, etc.)

Default: []nullable
iduuiderforderlich

Unique component identifier (UUIDv7)

categorystringerforderlich

Component category

RAMCPUGPUHDDSSDPSUMAINBOARDNICOPTICAL_DRIVEEXPANSION_CARDOTHER
manufacturerstringoptional

Component manufacturer

max 100 Zeichennullable
modelstringoptional

Component model name

max 200 Zeichennullable
serialNumberstringoptional

Component serial number

max 100 Zeichennullable
specificationstringoptional

Free-text specification (e.g. "32 GB DDR5 4800 MHz")

max 500 Zeichennullable
quantityintegeroptional

Number of identical components

≥ 1Default: 1nullable
statusstringoptional

Component health status

OKDEGRADEDFAILEDREPLACED
nullable
installedAtdateoptional

Installation date

nullable
notesstringoptional

Free-text notes

max 2000 Zeichennullable
sourceRefobjectoptional

Reference to the source system this entity was imported from

Default: nullnullable
systemstringerforderlich

Source system identifier (e.g. tanss, weclapp)

idstringerforderlich

Entity ID in the source system

Standard-Endpoints

Diese Resource folgt dem generischen CRUD-Vertrag der Plattform. Lesen Sie die Konventionen für Pagination, Idempotenz, Optimistic Locking und Audit. Die wichtigsten Endpoints:

  • GET /api/v1/assets — Liste, paginiert + filterbar
  • GET /api/v1/assets/<id> — Einzelne Entity
  • POST /api/v1/assets — Anlegen
  • PATCH /api/v1/assets/<id> — Teil-Update
  • DELETE /api/v1/assets/<id> — Soft-Delete
  • GET /api/v1/assets/<id>/timeline — Audit + Aktivitäten

Suche