Query RelationshipTemplates

This use case queries RelationshipTemplates of the Identity.

Parameters

All parameters are optional. If no parameter is given, all RelationshipTemplates are returned.

• isOwn indicates if the RelationshipTemplate was created by the current Identity.
• createdAt is the ISODateTime the RelationshipTemplate was created at.
• expiresAt is the ISODateTime the RelationshipTemplate expires.
• createdBy is the enmeshed address of the Identity that created the RelationshipTemplate.
• createdByDevice is the id of the Device that created the RelationshipTemplate.
• maxNumberOfAllocations is the number of times the RelationshipTemplate can be accessed by different Identities to initiate a Relationship. The Backbone returns an error if one accesses a RelationshipTemplate with no allocations left. Accessing the same RelationshipTemplate with the same Identity multiple times doesn’t affect the number of allocations. The allocation counts, even if the Identity does not accept the RelationshipTemplate by discarding it.
• forIdentity is the enmeshed address of the Identity for which the RelationshipTemplate is intended.
• passwordProtection is an object for PasswordProtection of a RelationshipTemplate.

On Success

• Returns all RelationshipTemplates that match the query.

On Failure

• The parameters are malformed.

How to execute this use case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use case. This use case can be executed with the REST API of the Connector which you can Access the Connector.

Corresponding interactive API docs excerpt: