This use case allows you to retrieve a list of LocalAttribute versions shared with a given peer. Since only the LocalAttribute subtypes OwnIdentityAttribute, OwnRelationshipAttribute, and PeerRelationshipAttribute represent forwardable Attributes, a list of shared versions can only be retrieved for such LocalAttributes.

Parameters

  • The attributeId belonging to a LocalAttribute you would like to know the versions shared with a specific peer of.
  • The returned LocalAttribute versions are limited to those shared with a specific peer.
  • onlyLatestVersions omits succeeded versions such that only the most recent version you shared with the peer is returned. In detail, this means that if the attributeId given as input belongs to a LocalAttribute that already has successors you also shared with the peer, only the most recently shared successor will be returned. By default this is set to be true.

On Success

  • A list of versions of the LocalAttribute belonging to the given attributeId shared with the specified peer is returned.
  • If onlyLatestVersions is disabled, all versions shared with the peer will be returned, even if they already have successors.

On Failure

  • No LocalAttributes can be returned if the attributeId correlates to an unknown LocalAttribute.
  • No LocalAttributes can be returned if the attributeId doesn’t belong to an OwnIdentityAttribute, an OwnRelationshipAttribute, or a PeerRelationshipAttribute.
  • No LocalAttributes 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: