Ifd:IFD API

From dev.ifd-library.org

(Redirected from IFD API)

An overview of the object model and a list of functions available through the standard WSDL API.

2.0.5 version of API WSDL: http://services.ifd-library.org/api/2.0?wsdl
3.0 version of API WSDL: http://services.ifd-library.org/api/3.0/wsdl/soap.wsdl

Both of these APIs point to the same database, so users of API 2.0_5 will be able to see the exact same content as the users of API 3.0. Everyone is encouraged to move their applications to 3.0, as 2.0_5 is deprecated, and will be removed.

The documentation for API 3.0 can be found here

You need a user name in order to add information using the API. 
Here is information about how to get one. 
If you want to browse the API you are free to do that using the demo user. 
Username : demo, Password : demo.

Object model

Classes

Types

string

Enumerations

API overview

Search functions

searchForConcepts - the standard search for objects in the library
searchForNames - search for names.
searchForDuplicates - a search to see if the objects already exist in the Ifd library
search_concepts - search of concepts by pattern of their name.
search_within_one_language - the search for objects in the library with one language.

Get functions

getConcept - get the concept
getMeasuresForProperty - get measure information with values and unit. Takes a property as input.
getMeasure - get measure infomation with values and unit. Takes a measure as input.
getLanguages - list all languages available in the library
getParentConcepts - list all parent (relating) concepts of the current concept
getChildrenConcepts - list all children (related) concepts of the current concept
getOrganizations - list all organizations in the system
getConstrainedValues - get all measures and contexts with constrained values that are constrained in the combination of a property and an object
getConstrainedMeasures - get all measures with constrained values that are constrained in the combination of a property and an object
getContexts - list all contexts available in the library
getContextOwners - returns all owners of a context.
getContextUsers - returns all users of a context.
getOrganizationMembers - returns all users that are members of a given organization.
getUsers - list all users in the system
get_all_children - returns all children of the concept specified by its guid
get_all_parents - function returns all parents of the concept specified by its guid
get_concept - returns fully specified concept by its global unique id

Add functions

Add functions will carry out functions on all concepts and their sub-concepts. E.g if an IfdConcept contains both a new concepts and new names for that concept, all of these will be created.

addConcepts - add new concepts (subjects, activitys, actors, documents, properties, values or units)
addParents - add a list of parents to a concept.
addChildren - add a list of children to a concept.
addNamesToConcept - add new names (one or more) to a concept
addCommentsToConcept - add one or more new comments to a concept
addDefinitionsToConcept - add new definitions to a concept
addUser - add user to system
addOrganizations - add organization to system
addLanguages - add languages to system
addConstrainedValues - add a set of values to constrain a measure of a property
addPreference - adds the current users organisation to the list of organisations preferring the name, description or illustration
addContexts - adds a new context.
addContextOwners - adds owners to a context.
addContextUsers - adds users to a context.
addValues - adds new values.
addNamesToContext - Add one or more names to a context.
addDescriptions - add both definitions and comments in one call to the specified concept".
addIllustrations - adds illustrations to the specified concept.
addMeasures - adds measure concepts to the target IFD populationt.

Update functions

Add functions will carry out functions only on the concept itself. Nothing will be done on the sub concepts. E.g when updating an IfdConcept that contains both a concepts and updated names for that concept, then ONLY the concept will be updated.

updateConcept - update one or more attributes of an existing concept
updateName - update the name for the current concept
updateDescription - update the description for the current concept
updateUser - update user
updateOrganization - update organization
updateLanguage - update language
updateValue - update value
updateContext - update context
updatePasswordForUser- update password for user
updatePasswordForCurrentUser- update password for current user
updateComment - updates specified comment of the concept.
updateDefinition - updates specified definition of the concept.
updateIllustration - updates specified illustration of the concept.
correctSpellingForName - update the name for all concept using the name
correctSpellingForDescription - update the description for all concept using the name

Remove functions

removeChildFromConcept - remove a child from a concept (to remove a parent, move to the parent and then remove this child from the parent using this function). This do not delete the Child from the library
removeParentFromConcept -
removeNameFromConcept -
removeDefinitionFromConcept -
removeCommmentFromConcept -
removeIllustrationFromConcept -
removeNameFromContext - remove name from context
removePreference - removes the current users organisation to the list of organisations preferring the name, description or illustration
removeConstrainedValues - remove constrained values
removeContextOwner - removes a owner from a context.
removeContextUser - removes a user from a context.

Merge functions

mergeDuplicates -merges two identical concepts. One of the guid's is kept while the other get the status. "TRANSFERRED"

Miscellaneous functions

sendPasswordToEmail - send password to users email
getAPIVersion - return version of this API
login - login to the system
logout - logout from the system
getLoggedInUserList - get a list of users currently logged in to the system
getCurrentUser - get the current user
getCurrentUserRights - get current user rights
getErrorMessage - get the error message for error code returned from one of the methods if something went wrong
getTestBuffer - test function

Synchronization functions

"It was ordered, designed and developed special functionality to synchronize two IFD populations: master copy of IFD population (original) and partly changed part of the population – local copy. It is out of scope – way to populate local copy with subset of master IFD population. The main idea - master copy initially was a source of local copy population. The population is subset of the IFD population – limited in names/descriptions by selected languages and in relationships by selected contexts. Time being master and local copies were changed with newly created, removed and updated concepts and relationships. It is prohibited to create new contexts, languages, users and organization in local copy. To support synchronization – have possibility to return back into master copy updated subset of IFD population was introduced special rules to mark with date/time stamp all changes in the IFD population (concepts and their relationships) and the following data structures and functionality."

IfdDelta all concepts and relationships that were changed".
IfdRelationship represents general IFD relationship attributes".
IfdConflict represents conflicts raised in a merge of a source IFD data to a target IFD population".
IfdChange structure represents one shallow change".
IfdChanges represents shallow changes in target IFD population".
get_delta_of_concepts function investigates target population and collects all concepts and their relationships".
import_delta merges delta (changes) from a local IFD population to a target IFD population".
get_changes investigate target IFD population collecting shallow info about all changed".

Development

Return to the LexiCon - BARBi unification page