Get Attributes

This use case is intended to query LocalAttributes. The LocalAttributes can be specified using a complex query.

Parameters

• query allows to specify the conditions for the returned LocalAttributes. In detail, the following keys may be used:
  • createdAt describes the time when the LocalAttribute was created.
  • parentId can be used to find the child Attributes of a complex IdentityAttribute.
  • The fields of content can be used to describe the queried Attribute (either an IdentityAttribute or a RelationshipAttribute).
  • succeeds and succeededBy give information about the succession state of the LocalAttribute.
  • The fields of the shareInfo describe if the LocalAttribute is shared with a peer and specify its LocalAttributeShareInfo.
  • The fields of the deletionInfo describe the LocalAttributeDeletionInfo of a shared LocalAttribute.
  • isDefault states whether a RepositoryAttribute is the default for its value type.
• If onlyValid is set to true, LocalAttributes that exceed their validity frame defined by validFrom and validTo will not be returned.
• If hideTechnical is set to true, RelationshipAttributes with isTechnical true will not be returned.

On Success

• Returns a list of LocalAttributes that match the parameters.

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: