Wiki source code of The CB-NL API

Last modified by Arjan Loeffen on 2015/06/12 13:54
Content · Comments (0) · Attachments (10) · History · Information
Hide line numbers
  1: = Introduction to the XML API =
  2: 
  3: The CB-NL core and some context ontologies are accessible by a SparQL (RDF/OWL) API. This API is available at http://api.cbnl.org/sparql. This API is decribed here: [[SPARQL-endpoint]]. This REST API accepts SPARQL queries, and returns RDF results (as Json or XML, as requested).
  4: 
  5: The team recognizes that many software vendors do not have the knowledge or inclination to use the RDF/OWL API, create SPARQL queries and process the results. Therefore an alternative API is provided, accepting commands and parameters rather than full queries, and returning expressive XML, rather than SPARQL results. This API is loosely based on the BsDD API 1.0 syntax. This is described below. 
  6: 
  7: The results of the XML API calls (the “Payload”) conform to an XML Schema. A separate XML schema is created for each type of result. All schemas are based on a common information model, expressed in UML. This UML model shows what constructs are recognized as part of the OWL ontology, what (meta)data these constructs have, and what relations exist. The model is documented in this “base UML”.
  8: 
  9: For each payload a separate, derived UML is created, and a corresponding XML schema is provided. The API is modelled as:
 10: 
 11: * **PayloadServices-items** — Return all concepts, relations, collections (…) within a single context and release. Only records the identifying data of the item.
 12: * **PayloadServices-construct** — Return all information on concept, relation or collection within a single context and release. This includes all meta information, and URI of supertypes, relations and collections.
 13: * **PayloadServices-definition** — Return a concise definition of a concept.
 14: * **PayloadServices-links** — Provide all "links" that any item has with other items. This concerns collections, relations, concepts, data properties, contexts, libraries and works.
 15: * **PayloadServices-search** — Search for items within a single context and release, based on a text search. This returns all fragments including a marker for the location of the text found and a reference to the item. The item is identified by URI, name and status info. 
 16: * **PayloadServices-comments** — Return all comments on a single item in a single context but any release. This includes all comment info, including the release.
 17: * **PayloadServices-library** — Return information on the library specified.
 18: 
 19: The Payload UML is designed specifically for the CB-NL. Mostly the same information may be represented by payloads that follow IFC 1.0 (the payload model for BsDD calls). Therefore, an alternative Payload model (and schema) is available to represent the ontology in that form. This is work in progress.
 20: 
 21: Check the following resources for more detailed information.
 22: 
 23: * SPARQL API (http://api.cbnl.org/sparql
 24: * XML API overview ([[http://api.cbnl.org/xml/1.0]]) 
 25: * UML base model (below)
 26: * IFD schema (http://bsddpilot.catenda.no/docs/objects.xsd, http://bsddpilot.catenda.no/docs/pset.xsd )
 27: * BsDD API (Peregrine API) (http://bsddpilot.catenda.no/docs/
 28: * Overview of the BsDD API (http://staging.bsdd.buildingsmart.org/docs/index.html
 29: * REST ([[Representational State Transfer (REST)>>url:http://en.wikipedia.org/wiki/Representational_state_transfer||rel="__blank"]])
 30: 
 31: = The BsDD API format =
 32: 
 33: The BsDD (http://www.buildingsmart.org/standards/ifd) offers an API for quering and updating the constructs in the data dictionary. To this end it defines a REST syntax. Requests specified using this syntax will return some result (which may include an update in the dictionary itself). This result takes the form of an XML or JSON message. The format of the result is according to a schema with namespace http://peregrine.catenda.no/objects. This schema is generic, and all elements are optional; they will be inserted into the result when needed.
 34: 
 35: CB-NL has decided that the syntax of the API is attractive and should be the starting point for the CB-NL XML API. So access to CB-NL takes the form of similar requests.
 36: 
 37: The BsDD API is based on passing GUIDs, as the objects are identified by GUIDs. Example:
 38: http://staging.bsdd.buildingsmart.org/docs/api/4.0/IfdConcept/19ed4236-4a47-4497-9c15-96cc4b74f089 
 39: 
 40: For the CB-NL, this strategy cannot be adopted, as URIs can only be passed in URLs as request parameters. Therefore, we use two related approaches.
 41: 
 42: The special term “uri” is used to denote the URI passed as a request parameter, as in:
 43: http://api.cbnl.org/xml/1.0/core-cbnl/20140901/Item/uri?uri=http%3A%2F%2Font.cbnl.org%2Fcb%2Fdef%2FBrug  
 44: 
 45: We use the term “Item” to specify that any type of Item is allowed, although the URI (http://ont.cbnl.org/cb/def/Brug) represents a concept.
 46: 
 47: For concepts that are in the CB-NL core model the URI parameter syntax is equivalent to:
 48: http://api.cbnl.org/xml/1.0/core-cbnl/20150501/Concept/Brug 
 49: 
 50: which is translated automatically to the URI http://ont.cbnl.org/cb/def/Brug (resolved in the latest release).
 51: 
 52: For relations that are in the CB-NL core model this is equivalent to:
 53: http://api.cbnl.org/xml/1.0/core-cbnl/20150501/Relation/DoelFunctie 
 54: 
 55: For collections that are in the CB-NL core model this is equivalent to:
 56: http://api.cbnl.org/xml/1.0/core-cbnl/20150501/Collection/Draagconstructies 
 57: 
 58: The URI strategy states that the URI  itself should provide access to information. Which type of information this is, is determined by content negotiation. 
 59: 
 60: The CB-NL URI strategy uses the following conventions for any URI passed 
 61: 
 62: * When accessed by internet browser (accept-encoding=html)  rewrites to an HTML information page which shows in which context(s) and release(s) the item occurs. 
 63: * When accessed by REST (accept-encoding=xml) it returns an XML payload which represents in which context(s) and release(s) the item occurs.
 64: 
 65: = Introduction to the Payload model =
 66: 
 67: This section describes the base model of all payload data. 
 68: 
 69: The base model is composed in accordance with a “set of rules”, a metamodel, developed by Kadaster in collaboration with the Dutch Chamber of Commerce, Waarderingskamer, and VNG/KING. This metamodel is published elsewhere. 
 70: 
 71: The base model is the foundation of all individual payload models. These models are also in accordance with this metamodel, and offer a view on the base model. The basic approach is:
 72: 
 73: 1. The base model shows all we’ve got.
 74: 1. The payload model shows what’s needed in a particular response.
 75: 1. To understand any payload model requires understanding of the base model. 
 76: 
 77: (((
 78: (% style="line-height: 19.6000003814697px;" %)The base and payload service models can be accessed directly as a ZIP file using the links:
 79: 
 80: 1. [[Base>>url:http://viewer.cbnl.org/api/zip/WSPayload-CBNLPayloadBase-1.0.0-2-20141001-at-20141028-100047.zip]] payload model
 81: 1. [[PayloadServices-items>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-items-1.0.0-2-20141001-at-20141010-163645.zip]]
 82: 1. [[PayloadServices-construct>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-construct-1.0.0-2-20141001-at-20141010-163503.zip]]
 83: 1. [[PayloadServices-definition>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-definition-1.0.0-2-20141001-at-20141010-163825.zip]]
 84: 1. [[PayloadServices-links>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-links-1.0.0-2-20141001-at-20141010-163614.zip]]
 85: 1. [[PayloadServices-subtypes>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-links-1.0.0-2-20141001-at-20141010-163614.zip]]
 86: 1. [[PayloadServices-search>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-search-1.0.0-2-20141001-at-20141010-163718.zip]]
 87: 1. [[PayloadServices-comments>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-comments-1.0.0-2-20141001-at-20141010-163751.zip]]
 88: 1. [[PayloadServices-library>>url:http://viewer.cbnl.org/api/zip/WSPayload-PayloadServices-library-1.0.0-2-20141001-at-20141010-163543.zip]]
 89: )))
 90: 
 91: The base model is as follows.
 92: 
 93: [[image:EA3.png]]
 94: 
 95: A particular payload model consists of two parts:
 96: 
 97: * A “Header” block that specifies which objects are relevant in the response.
 98: * A selection of the base model that only identifies the objects and properties that are passed.
 99: 
100: As an example, the following UML model shows which parts are relevant for the “library” information call (**PayloadServices-library**):
101: 
102: [[image:EA31.png]]
103: 
104: The subset of the base model relevant for this service response is modelled separately, offering a view on the base model:
105: 
106: [[image:ea32.png]]
107: 
108: = The Payload JSON format =
109: 
110: The information passed in XML is also available as JSON. In order to access REST services in JSON format, pass the parameter mode=json, for example:
111: 
112: http:~/~/viewer.cbnl.org/bsdd-api/v1.0/core-cbnl/20150501/Concept/uri?uri=http%3A%2F%2Font.cbnl.org%2Fcb%2Fdef%2FBrug&mode=json
113: 
114: The JSON result is an immediate translation of the XML structure (and UML model) to JSON constructs. 
115: 
116: = The Payload XML format =
117: 
118: This section describes the structure of the XML documents returned in an XML API call.
119: 
120: The UML specification is complete, and identifies all information passed back in an API response. This response is primarily formatted as an XML message. There is a fixed set of rules that is followed to transform a UML class, attribute, association and so on, to generate a corresponding XML message. These rules are as follows.
121: 
122: 1. Classes are modelled as global elements
123: 1. Attributes and relations are modelled as local elements
124: 1. When an association’s target is an Object type (stereotype <<objecttype>>), the target is represented by a Ref element. This Ref element holds a reference (xlink href) to the URI of the targeted item. The targeted item is then part of a special “collection” element, called <ResultComponents>. In fact, all items are placed in this collection, this allowing full networked structures to be passed in response, as well as a structurally validating XML schema.
125: 
126: The XML API overview (http://api.cbnl.org/xml/1.0) is generated based on available services, and may change in time. It holds the following information.
127: 
128: Model name — __XSD__ | __APP__ | __ZIP__ 
129: 
130: * __XSD__ shows the XSD in pretty-printed form
131: * __APP__ provides access to all (technical/managerial) information that concerns the model and the XML Schema build
132: * __ZIP__ holds the complete APP as a download ZIP.
133: 
134: The APP shows the readme file, which gives access to documentation, the UML model, and the XSD.
135: 
136: The overview provides examples of API calls that conform to the API syntax and the response format as described. 
137: 
138: Note: for technical purposes a non-cached version of each call may be accessed using the [__nc__] link.