Open Inventory / Docs
EndpunkteInventory structureInventory typesKey

Archive an inventory type

Die API läuft auf deiner Anwendungsinstanz. Schemas und Feldnamen stammen unverändert aus der OpenAPI-Spezifikation. Browsergebundene Aufrufe benötigen eine Sitzung auf der Instanz.

DELETE
/inventory-types/{key}

Requires an authenticated administrator browser session. Existing inventory records retain their type; the fallback type cannot be archived.

Authentifizierung

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

Pfadparameter

key*string

Stable key of an administrator-configurable inventory type.

Muster^[a-z][a-z0-9_-]{0,63}$
Länge1 <= length <= 64

Header-Parameter

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Antwortinhalt

Inventory type archived

application/json
  1. response
type*
Beispielanfrage
curl -X DELETE 'https://inventory.example.com/api/v1/inventory-types/string'
Beispielantwort
{  "type": {    "key": "string",    "label": "string",    "description": "string",    "color": "string",    "icon": "string",    "canContain": true,    "spatialContainment": true,    "position": 0,    "isSystem": true,    "createdBy": "string",    "updatedBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "archivedAt": "2019-08-24T14:15:22Z"  }}