Interfaces



The Web service interface of the Fragmento repository provides the following operations:



Concerning Artefacts

  • createArtefact: This operation is used to create a new artefact in the repository. The operation returns the identifier of the created version descriptor.
  • retrieveArtefact: This operation is used to retrieve an artefact, without performing a check out. This operation optionally allows specifying or referencing a view transformation rule that is applied to the artefact before it is returned.
  • retrieveArtefactBundle: This operation returns an artefact and all the artefacts that are related to it.
  • retrieveArtefactHistory: This operation returns a list of version descriptor identifiers that represent the version history of an artefact.
  • checkOutArtefact: This operation sets a lock on the requested artefact and returns it. It also returns a lock identifier which is required for check in.
  • checkInArtefact: This operation creates a new version of an artefact. For authorization also the corresponding lock identifier has to be passed. Based on the parameter keepRelations, the relations of this artefact also apply to its new version (i.e. Fragmento creates new relations). It returns the identifier of the new version.
  • browseArtefacts: This operation implements the search function. Based on the input parameters this operation returns a list of version descriptors that match the query (considering only the head revision, i.e. the latest versions). As input parameters are accepted: artefact type, interval of creation, or search string for description or document content.
  • retrieveArtefactLatestVersion: This operation returns the latest version of an artefact.
  • browseLocks: This operation returns a list of all locked artefacts.
  • releaseLocks: This operation can be used to release a lock.

Concerning Relations

  • createRelation: This operation allows creating a relation from one artefact to another. The description can by characterized by a type and a description. This operation can also be extended for providing an advanced annotation mechanism.
  • retrieveRelation: This operation returns the details of a relation.
  • browseRelations: This operation provides search functionality for relations. Valid input parameters are either a source (a version descriptor identifier), a target, a type, or an interval for its creation.
  • updateRelation: This operation provides the update mechanism for relations. As relations are not versioned, there is no check out or check in function.
  • deleteRelation: This operation completely deletes a relation.