Ifd:IFD API

From dev.ifd-library.org

An overview of the object model and a list of functions available through the standard WSDL API. The API is the result of the LexiCon - BARBi unification project.

2.0 version of API up and running, get the WSDL at: http://services.ifd-library.org/api/2.0?wsdl

You need a user name in order to use the API. Here is information about how to get one.

For step by step examples of how to use the API see: Step by Step guide to use of the IFD api

Contents 1 Object model 1.1 Classes 1.2 Types 1.3 Enumerations 2 Functions 2.1 Search functions 2.2 Get functions 2.3 Add functions 2.4 Update functions 2.5 Remove functions 2.6 Merge functions 2.7 Miscellaneous functions 2.8 Postponed functions 3 EXPRESS-X documentation

[edit] Object model

[edit] Classes

• IfdConcept
  • IfdMeasure
    • IfdMeasureInRelationship
  • IfdValue
  • IfdConceptInRelationship
• IfdContext
• IfdName
• IfdDescription
• IfdLanguage
• IfdIllustration
• IfdOrganization
• IfdUser

[edit] Types

• string

[edit] Enumerations

• IfdStatusEnum
• IfdValueTypeEnum
• IfdRelationshipTypeEnum
• IfdConceptTypeEnum
• IfdNameTypeEnum
• IfdDescriptionTypeEnum
• IfdLogicalTypeEnum
• IfdToleranceTypeEnum

[edit] Functions

Functions defined for the ODIN project (many of them are implemented in the old WSDL interface (version 1.0)): http://odin.byggforsk.no/index.php/IFD_input_API

Icon explanation

• RED- means not ready
• OLIVE - means started on but not yet ready
• GREEN - means finished

• - J means the Java layer
• - E means the EXPESS layer
• - T means testing and verification
• - U means user rights
• - ? means that the function is being discussed

The icons might be followed by a short notice about the last change or status.

Overview of methods impimented in the current (v.1.1) version of the WSDL API: Old_API_Method_List

[edit] 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

[edit] 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.
• getConceptFromName - get concept from name. Note: This function is not part of the current WSDL 2.0 API.
• 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

[edit] 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. (EXPRESS takes string input ?)
• addChildren - add a list of children to a concept. (EXPRESS takes string input ?)
• 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. 1
• 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.

[edit] 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

• correctSpellingForName - update the name for all concept using the name
• correctSpellingForDescription - update the description for all concept using the name

[edit] 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.

[edit] Merge functions

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

[edit] 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

[edit] Postponed functions

The following list of functions will not be implemented in version 2 of the WSDL interface. They are subject for discussions and will have to be implemented in later versions of the API.

• getValueAttributes - get additional attribute for the value-concept (sub function lacks proper is_preferred implementation)
• getMeasureAttributes - get additional attribute for the measure-concept (sub function lacks proper is_preferred implementation)
• getNames - list all names of the selected languages and of the selected types
• getConceptsWithName - list all concepts with the selected name
• getConceptTypes - list all concept types in the enumeration
• makeIfdGuid - make a GUID suitable for the IFD

[edit] EXPRESS-X documentation

• EXPRESS X Query Schema

Return to the LexiCon - BARBi unification page