Resources

The resources use a data model that is supported by a set of client-side libraries that are made available on the files and libraries page.

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
IfdAPIResource
  • /IfdAPI/version
  • GET
The Class IfdAPIResource. This class provides some meta data about the API.
IfdConceptResource
  • /IfdConcept
  • /IfdConcept/list
  • /IfdConcept/search
  • /IfdConcept/searchForDuplicates
  • /IfdConcept/{guid}
  • /IfdConcept/filter/{conceptType}
  • /IfdConcept/preferred/list
  • /IfdConcept/preferred/{guid}
  • /IfdConcept/search/{searchString}
  • /IfdConcept/withfullname/{nameGuid}
  • /IfdConcept/{guid}/child
  • /IfdConcept/{guid}/children
  • /IfdConcept/{guid}/comment
  • /IfdConcept/{guid}/definition
  • /IfdConcept/{guid}/illustration
  • /IfdConcept/{guid}/name
  • /IfdConcept/{guid}/parent
  • /IfdConcept/{guid}/parents
  • /IfdConcept/{guid}/status
  • /IfdConcept/search/filter/language
  • /IfdConcept/search/filter/type
  • /IfdConcept/{guid}/children/{relationshipType}
  • /IfdConcept/{guid}/description/{descriptionGuid}
  • /IfdConcept/{guid}/illustration/{illustrationGuid}
  • /IfdConcept/{guid}/mergeWith/{guidToMerge}
  • /IfdConcept/{guid}/name/{nameGuid}
  • /IfdConcept/{guid}/parents/{relationshipType}
  • /IfdConcept/search/filter/language/type
  • /IfdConcept/searchForDuplicates/filter/type/{conceptType}
  • /IfdConcept/search/filter/language/{languageGuid}/{searchString}
  • /IfdConcept/search/filter/type/{conceptType}/{searchString}
  • /IfdConcept/{guid}/childGuid/{childGuid}/relationshipType/{relationshipType}
  • /IfdConcept/{guid}/children/filter/context/{contextGuid}
  • /IfdConcept/{guid}/children/filter/language/{languageGuid}
  • /IfdConcept/{guid}/parentGuid/{parentGuid}/relationshipType/{relationshipType}
  • /IfdConcept/{guid}/parents/filter/context/{contextGuid}
  • /IfdConcept/{guid}/parents/filter/language/{languageGuid}
  • /IfdConcept/search/filter/language/{languageGuid}/type/{conceptType}/{searchString}
  • /IfdConcept/{guid}/childGuid/{childGuid}/relationshipType/{relationshipType}/contextGuid/{contextGuid}
  • /IfdConcept/{guid}/childGuid/{childGuid}/relationshipType/{relationshipType}/contextGuids/{contextGuids}
  • /IfdConcept/{guid}/parentGuid/{parentGuid}/relationshipType/{relationshipType}/contextGuid/{contextGuid}
  • /IfdConcept/{guid}/parentGuid/{parentGuid}/relationshipType/{relationshipType}/contextGuids/{contextGuids}
  • POST
  • GET
  • POST
  • POST
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • GET POST
  • POST PUT
  • POST PUT
  • PUT
  • POST PUT
  • POST
  • GET POST
  • PUT
  • POST
  • POST
  • GET
  • DELETE
  • DELETE
  • POST
  • DELETE
  • GET
  • POST
  • POST
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • DELETE
  • GET
  • GET
  • GET
  • DELETE
  • DELETE
  • DELETE
  • DELETE
The Class IfdConceptResource. This class is used to manage IfdConcept objects.
IfdContextResource
  • /IfdContext
  • /IfdContext/currentUserCanEdit
  • /IfdContext/currentUserHasReadAccess
  • /IfdContext/currentUserIsOwner
  • /IfdContext/{guid}
  • /IfdContext/{guid}/copy
  • /IfdContext/{guid}/ownerIDs
  • /IfdContext/{guid}/owners
  • /IfdContext/{guid}/userIDs
  • /IfdContext/{guid}/users
  • /IfdContext/{guid}/owner/{ownerGuid}
  • /IfdContext/{guid}/user/{userGuid}
  • GET POST
  • GET
  • GET
  • GET
  • DELETE GET PUT
  • POST
  • GET
  • POST
  • GET
  • POST
  • DELETE
  • DELETE
The Class IfdContextResource. This class is used to manage IfdContext objects. Contexts are used to filter relationships. By default all relationships are shown in the buildingSMART Data Dictionary. There are many ways to model the relationships beween concepts and bSDD allows different user groups to model their view in a context. Sometimes relationships might be shared between contexts, other times not. A context can be open (unrestricted) or restricted (closed). If open, everyone can see the context and use it to filter relationships. If the context is restricted/closed only owners and users of the context can see the context an use it for filtering. Closed contexts will appear in the list of contects but will not be visible on relationships unless you the ovner or user of the contect. A context can in adittion to being restricted/closed be readOnly. A read only context can only be added to or edited by the contex owners. Not the contect users. This also applies to non restricted/open contexts. When a context is readOnly a context user can only use it for filtering and not add to the context.
IfdDescriptionResource
  • /IfdDescription
  • /IfdDescription/{guid}
  • POST
  • GET POST PUT
The Class IfdDescriptionResource. This class is used to manage IfdDescription objects.
IfdIllustrationResource
  • /IfdIllustration
  • /IfdIllustration/{guid}
  • POST
  • GET PUT
The Class IfdIllustrationResource. This class is used to manage IfdIllustration objects.
IfdLanguageRepresentationPreferenceResource
  • /IfdLanguageRepresentationPreference
  • /IfdLanguageRepresentationPreference/{guid}
  • /IfdLanguageRepresentationPreference/forLanguageRepresentationObject/{langRepGuid}
  • POST
  • DELETE GET PUT
  • GET
The Class IfdLanguageRepresentationPreferenceResource. This class is used to manage IfdLanguageRepresentationPreference objects.
IfdLanguageResource
  • /IfdLanguage
  • /IfdLanguage/{guid}
  • GET POST
  • DELETE GET PUT
The Class IfdLanguageResource provides methods to access the various languages in buildingSMART Data Dictionary.
IfdLoginResource
  • /session/login
  • /session/logout
  • POST
  • POST
The Class IfdLoginResource. This class is used to manage access to the buildingSMART Data Dictionary.
IfdNameResource
  • /IfdName
  • /IfdName/{guid}
  • /IfdName/search/{searchString}
  • /IfdName/{guid}/correctSpelling
  • /IfdName/{guid}/forConcept/{conceptGuid}
  • /IfdName/{guid}/forConceptGetNameGuid/{conceptGuid}
  • /IfdName/search/filter/language/{languageGuid}/{searchString}
  • /IfdName/search/filter/language/{languageGuid}/nametype/{nameType}/{searchString}
  • POST
  • DELETE GET PUT
  • GET
  • PUT
  • PUT
  • PUT
  • GET
  • GET
The Class IfdNameResource. This class is used to manage IfdName objects.
IfdOrganizationResource
  • /IfdOrganization
  • /IfdOrganization/{guid}
  • GET POST
  • DELETE GET PUT
The Class IfdOrganizationResource. This class is used to manage IfdOrganization objects.
IfdPSetPropertyResource
  • /IfdPSetProperty/{guid}
  • /IfdPSetProperty/View/{guid}
  • GET
  • GET
The Class IfdPSetPropertyResource. This class is used to manage IfdPSetProperty objects.
IfdPSetResource
  • /IfdPSet/search/{searchString}
  • /IfdPSet/{guid}/ifcVersion/{ifcVersion}
  • /IfdPSet/{guid}/View/ifcVersion/{ifcVersion}
  • /IfdPSet/{guid}/ifcVersion/{ifcVersion}/XML
  • GET
  • GET
  • GET
  • GET
The Class IfdPSetResource. This class is used to manage IfdPset objects.
IfdPropertyResource
  • /IfdProperty/forConcept/{conceptGuid}
  • GET
The Class IfdPropertyResource. This class is used to manage IfdProperty objects.
IfdPropertyWithValuesResource
  • /IfdPropertyWithValues/forConcept/{conceptGuid}
  • /IfdPropertyWithValues/forConcept/{conceptGuid}/filter/context/{contextGuid}
  • GET
  • GET
The Class IfdPropertyWithValuesResource. This class is used to manage IfdPropertyWithValues objects.
IfdRelationshipResource
  • /IfdRelationship
  • /IfdRelationship/{guid}
  • /IfdRelationship/childrenRelationshipsOf/{conceptGuid}
  • /IfdRelationship/parentRelationshipsOf/{conceptGuid}
  • /IfdRelationship/validrelations/{parentType}/{childType}
  • POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
The Class IfdConceptRelationshipResource. This class is used to manage IfdRelationship objects.
IfdRelationshipWithValuesResource
  • /IfdRelationshipWithValues
  • /IfdRelationshipWithValues/addValue
  • /IfdRelationshipWithValues/removeValue
  • /IfdRelationshipWithValues/{guid}
  • POST
  • POST
  • POST
  • DELETE
The Class IfdRelationshipWithValuesResource is used to manage all the IfdRelationshipWithValues objects.
IfdSandboxConceptResource
  • /IfdSandboxConcept/search
  • /IfdSandboxConcept/{sandboxGuid}
  • /IfdSandboxConcept/search/{searchString}
  • /IfdSandboxConcept/{sandboxGuid}/{guid}
  • /IfdSandboxConcept/search/filter/language
  • /IfdSandboxConcept/search/filter/type
  • /IfdSandboxConcept/{sandboxGuid}/filter/{conceptType}
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/children
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/definition
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/illustration
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/name
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/parents
  • /IfdSandboxConcept/search/filter/language/type
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/description/{descriptionGuid}
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/illustration/{illustrationGuid}
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/name/{nameGuid}
  • /IfdSandboxConcept/search/filter/language/{languageGuid}/{searchString}
  • /IfdSandboxConcept/search/filter/type/{conceptType}/{searchString}
  • /IfdSandboxConcept/{sandboxGuid}/{guid}/childGuid/{childGuid}/relationshipType/{relationshipType}
  • /IfdSandboxConcept/search/filter/language/{languageGuid}/type/{conceptType}/{searchString}
  • POST
  • POST
  • GET
  • DELETE GET
  • POST
  • POST
  • GET
  • GET POST
  • POST PUT
  • PUT
  • POST PUT
  • GET
  • POST
  • DELETE
  • DELETE
  • DELETE
  • GET
  • GET
  • DELETE
  • GET
The Class IfdSandboxConceptResource. This allows users to manage sandbox concepts.
IfdSandboxResource
  • /IfdSandbox
  • /IfdSandbox/{guid}
  • GET POST
  • DELETE GET
The Class IfdSandboxResource. This is used to manage your own sandboxes where you can have private concepts called IfdSandboxConcept. These concepts can relate to other sandbox concepts or existing public concepts. This feature is under development, and is likely to change dramatically.
IfdSimpleConceptResource
  • /IfdSimpleConcept/{guid}/children/{relationshipType}/filter/language/{languageGuid}
  • /IfdSimpleConcept/{guid}/parents/{relationshipType}/filter/language/{languageGuid}
  • GET
  • GET
The Class IfdSimpleConceptResource. This class is used to get lists of simple concepts.
IfdSimplePropertyResource
  • /IfdSimpleProperty/list/forConceptWtihGuid/{parentGuid}/filter/language/{languageGuid}
  • GET
The Class IfdSimplePropertyResource. This is used to get IfdSimpleProperty objects.
IfdSimpleRelationshipResource
  • /IfdSimpleRelationship/filter/{relationshipType}
  • GET
The Class IfdSimpleRelationshipResource. This class is used to manage IfdSimpleRelationship objects.
IfdStatisticsResource
  • /IfdStatistics/count/{objectName}
  • GET
The Class IfdStatisticsResource. This class is used to get statistics information about the data in bSDD.
IfdTagResource
  • /IfdTag/search/filter/language/{languageGuid}/{searchString}
  • /IfdTag/search/filter/language/{languageGuid}/type/{conceptType}/{searchString}
  • GET
  • GET
The Class IfdTagResource gives access to methods that returns IfdTag objects
IfdUserResource
  • /IfdUser
  • /IfdUser/changePasswordCurrentUser
  • /IfdUser/current
  • /IfdUser/online
  • /IfdUser/register
  • /IfdUser/resetAndSendNewPassword
  • /IfdUser/resetPassword
  • /IfdUser/{guid}
  • /IfdUser/email/{email}
  • /IfdUser/haveRole/{userRole}
  • /IfdUser/membersOf/{organizationGuid}
  • /IfdUser/search/{searchString}
  • /IfdUser/searchByEmail/{emailSearchString}
  • /IfdUser/{guid}/changePassword
  • /IfdUser/{guid}/disable
  • /IfdUser/{guid}/sendEmail
  • GET POST
  • POST
  • GET
  • GET
  • POST
  • POST
  • POST
  • DELETE GET PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • POST
  • PUT
  • POST
The Class IfdUserResource provides methods to access the various users in buildingSMART Data Dictionary.