Check if Relationship can be created

This use case checks whether a Relationship can be created based on a received RelationshipTemplate to the RelationshipTemplate’s creator without actually creating it. It makes sense to promptly execute this use case in order to prevent the data required to initiate a Relationship from being provided when this is currently not technically possible anyway. If a Relationship can be created, this can be achieved by executing the Create Relationship with RelationshipTemplate use case. If the Request Module is enabled and a RelationshipTemplateContent has been specified as the content of the RelationshipTemplate, the Accept incoming Request use case should be utilized to initiate a Relationship.

Parameters

• templateId references the RelationshipTemplate received from its creator.
• Optionally, creationContent can be provided. It is a RelationshipCreationContent or an ArbitraryRelationshipCreationContent depending on whether the RelationshipTemplate’s content is a RelationshipTemplateContent or an ArbitraryRelationshipTemplateContent. Specify this parameter if additional validations are wanted for the creationContent that would be used to create the Relationship.

On Success

• Returns a result that indicates if a Relationship can be created with the given parameters.
• If the isSuccess property of the result has the value true, a Relationship can currently be created to the creator of the RelationshipTemplate. This would then initially have "Pending" as status until the creator of the RelationshipTemplate accepts the Relationship.
• If the isSuccess property of the result has the value false, no Relationship can currently be created to the creator of the RelationshipTemplate. This can have various causes, for example:
  • 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, if specified, 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.
    
  • A RelationshipCreationContent was specified as creationContent, because the RelationshipTemplate’s content is a RelationshipTemplateContent, but there is no associated accepted incoming Request.
    
  • A RelationshipCreationContent was specified as creationContent, because 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.

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: