Integrate enmeshed

This use case allows you to retrieve a list of AttributeForwardingDetails for a given LocalAttribute. Since only the LocalAttribute subtypes OwnIdentityAttribute, OwnRelationshipAttribute, and PeerRelationshipAttribute represent forwardable Attributes, AttributeForwardingDetails can only exist for such LocalAttributes.

Parameters

  • The attributeId belonging to a LocalAttribute you would like to retrieve AttributeForwardingDetails of.
  • query allows to specify the conditions for the returned AttributeForwardingDetails. In detail, the following keys may be used:
    • peer describes the Identity the LocalAttribute is shared with.
    • sourceReference describes the id of the LocalRequest or LocalNotification the LocalAttribute was sent with.
    • sharedAt describes the time when the LocalAttribute was shared.
    • The fields of the deletionInfo describe the EmittedAttributeDeletionInfo of the AttributeForwardingDetails.

On Success

  • Returns a list of AttributeForwardingDetails for the LocalAttribute belonging to the given attributeId that match the query.

On Failure

  • No AttributeForwardingDetails can be returned if the attributeId correlates to an unknown LocalAttribute.
  • No AttributeForwardingDetails can be returned if 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: