Open Inventory / Docs
EndpunkteInventory structureRelation types

List configured relationship types

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.

GET
/relation-types

Requires the read scope. Administrators may include archived definitions.

Authentifizierung

bearerAuth
headerAuthentifizierungBearer <inv_ token>

Abfrageparameter

includeArchived?boolean

Include archived definitions when authenticated as an administrator.

Standardfalse

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

Relationship type definitions

application/json
  1. response
relationTypes*array<>
Beispielanfrage
curl -X GET 'https://inventory.example.com/api/v1/relation-types'
Beispielantwort
{  "relationTypes": [    {      "key": "string",      "label": "string",      "inverseLabel": "string",      "description": "string",      "allowManual": true,      "spatial": 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"    }  ]}