Create Relationship with RelationshipTemplate

This use case intends to create a Relationship based on a RelationshipTemplate, which was previously received. The Relationship will be established with the RelationshipTemplate’s creator. This use case must always be applied if the content of the RelationshipTemplate is an ArbitraryRelationshipTemplateContent. However, if it is a RelationshipTemplateContent, it usually does not have to be executed manually anymore. Instead, the Request Module, which is enabled by default, takes care of this automatically. For information on how to establish a Relationship based on a RelationshipTemplate with RelationshipTemplateContent and an enabled Request Module, refer to the corresponding scenario documentation. To check whether a Relationship can be created without actually creating it, the Check if Relationship can be created use case can be executed.

Parameters

• templateId references the RelationshipTemplate that was received from its creator.
• creationContent is an ArbitraryRelationshipCreationContent if the RelationshipTemplate’s content is an ArbitraryRelationshipTemplateContent and the use case is applied manually. It is a RelationshipCreationContent if the RelationshipTemplate’s content is a RelationshipTemplateContent and the Request Module automatically takes care of the execution of the use case. It will be stored inside the Relationship and can be analyzed by the creator of the RelationshipTemplate to decide whether to accept the Relationship.

On Success

• Creates and returns the Relationship.

On Failure

• The templateId does not resolve to a RelationshipTemplate or the associated RelationshipTemplate was not cached correctly.
• The RelationshipTemplate has already expired, which means that the timestamp specified in its expiresAt property has been exceeded.
• A Relationship with "Pending", "Active", "Terminated" or "DeletionProposed" as status already exists to the creator of the RelationshipTemplate. In particular, the initiation of a new Relationship is prevented if the potential initiator has already decomposed the former Relationship to the RelationshipTemplate’s creator, but the creator of the RelationshipTemplate has not yet decomposed it and still has the former Relationship with "DeletionProposed" as status.
• The Identity of the creator of the RelationshipTemplate is in deletion or has already been deleted.
• The creationContent is not a RelationshipCreationContent, although the RelationshipTemplate’s content is a RelationshipTemplateContent, or it is not an ArbitraryRelationshipCreationContent, although the RelationshipTemplate’s content is an ArbitraryRelationshipTemplateContent.
• The RelationshipTemplate’s content is a RelationshipTemplateContent, but there is no associated accepted incoming Request.
• The RelationshipTemplate’s content is a RelationshipTemplateContent and there is an associated accepted incoming Request, but its Response was not provided as the response of the specified RelationshipCreationContent.

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: