Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Overview of Webservices

String[]

getDescriptionForArchetype(String archetypeId, String language, String[] descriptionTerms)
          Retrieves the desired elements of the Description of the archetype.

String[]

getDescriptionForArchetypes(String[] archetypeIds, String language, String[] descriptionTerms)
          Retrieves the desired elements of the Description of a selection of Archetypes.

String[]

getDescriptionForAllArchetypes(String language, String[] descriptionTerms)
          Retrieves the desired elements of the Description for all active archetypes.

String[]

getArchetypeIdsSimple(String searchParamName, String searchParamValue)
          Retrieves the archetype-ids that fit the search query.

String[]
DEPRECATED

getArchetypeIds(String[] searchParams)
          Retrieves the archetype-ids that fit the search query in searchParams This is the most flexible method, exposing most of the functionality of the Archetype Finder in one method.

String[]

getArchetypeIdsFromPartialId(String archetypeIdPart)
          Searches for Archetype Ids based on a part of that Id (sorted by archetype id in ascending order).

String[]

getArchetypeIdsFromPartialIdWithPositioning(String archetypeIdPart, int cursor, int size)
          Searches for Archetype Ids based on a part of that Id taking into account a cursor position and max number of results (sorted by archetype id in ascending order).

String[]

getAllArchetypeIds()
Gets all active trunk archetypes sorted by archetype id in ascending order.

String[]

getAllArchetypeIdsWithPositioning(int cursor, int size)
Gets all active trunk archetypes taking into account a cursor position and max number of results (sorted by archetype id in ascending order).

String

getArchetypeADLURL(String archetypeId) | getArchetypeXMLURL(String archetypeId)
         Retrieves the URL to the ADL|XML representation of the Archetype.

String[]

getArchetypeADLURLs(String[] archetypeIds) | getArchetypeXMLURLs(String[] archetypeIds)
         Retrieves the URLs to the ADL|XML representation of the Archetypes.

String

getArchetypeInADL(String archetypeId) | getArchetypeInXML(String archetypeId)
          Retrieves the archetype in ADL-Form|XML-Form and gives it back as a String.

String[]

getArchetypesInADL(String[] archetypeIds) | getArchetypesInXML(String[] archetypeIds)
          Retrieves the archetypes in ADL-Form|XML-Form and gives them back as a String-array.

String

getArchetypeInADLFromCiteableId(String cidArchetype, Integer assetVersion) | getArchetypeInXMLFromCiteableId(String cidArchetype, Integer assetVersion)

         Retrieves an archetype in ADL|XML from its citeable identifier and asset version. You can see the citeable identifier of an archetype for example in the direct URL provided on the "Share with Colleague" tab of each archetype (when signed in - e.g. 1013.1.130)

String

getArchetypeMindmap(String archetypeId, String language, String locale)
          Retrieves the archetype in a freemind mindmap format as a String .

String

getParentArchetypeId(String archetypeId)
          Retrieves the archetype id of the parent of this archetype if any.

...