List relationships touching an inventory item
The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.
Returns incoming and outgoing directed relationships with both endpoint summaries and the relationship definition.
bearerAuthAuthorizationBearer <inv_ token>id*stringuuidX-Organization-ID?stringOrganization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.
uuidResource relationships
application/json- response
relations*array<>curl -X GET 'https://inventory.example.com/api/v1/resources/497f6eca-6276-4993-bfeb-53cbbbba6f08/relations'{ "relations": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "sourceResourceId": "481dd929-1ef7-4b4f-8c71-b35f932f1b65", "targetResourceId": "8b52d9f4-692a-4d1f-8c9f-c36bd283d92e", "relationTypeKey": "string", "origin": "manual", "sourceFeatureId": "string", "targetFeatureId": "string", "attributes": {}, "createdBy": "string", "createdAt": "2019-08-24T14:15:22Z", "source": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "string", "status": "available" }, "target": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "type": "string", "status": "available" }, "relationType": { "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" } } ]}Remove a manual resource relationship DELETE
Spatially derived relationships cannot be deleted directly. After deletion, spatial containment is recalculated.
Create or pin a manual relationship POST
One endpoint must match the resource id in the path. Containment relationships reject invalid parents, self-reference, and direct or indirect cycles. Creating an existing spatial relationship converts it to a manual relationship.