REST interface reading smartEA (iteraplan) data

CodingLaptop

REST interface reading smartEA (iteraplan) data

Since release 3.2 an REST interface is available to customers using the smartEA (iteraplan). This technical amendment represents the first step of an improved automatic processing of your EA data. Via an URl model and meta model data from smartEA (iteraplan) can be retrieved in JSON format for further editing. Such information can then be integrated into different IT management tools or displayed directly in a wiki. In the latest version this interface is read only, but further expansion of this functionality is planned already.

How the REST interface reading smartEA (iteraplan) data looks like:

Taking our online demo as example a query of the complete meta model is made using http://demo.smart360.biz/smartea/api/metamodel. Analogically all EA data can be requested using …/api/data to refine them outside of smartEA (iteraplan).

Alternatively selecting relevant information can be done in smartEA (iteraplan) directly. For example …/api/data/InformationSystem will supply a detailed list of building blocks of the type information system, …/api/data/InformationSystem/205 just the specific information system with ID 205:

{
  "query": "InformationSystem[@id\u003d205]",
  "result": {
    "id": [
      "205"
    ],
    "name": [
      "CRM # 3.1"
    ],
    "description": [
      "Management of customer data\r\n"
    ],

… further attributes

    "technicalComponentReleases": [
      {
        "id": "329",
        "name": "UNIX # Solaris",
        "elementURI": "http://demo.smart360.biz/smartea/api/data/TechnicalComponent/329"
      },
      {
        "id": "330",
        "name": "VM Ware Server # 2",
        "elementURI": "http://demo.smart360.biz/smartea/api/data/TechnicalComponent/330"
      }
    ],
    "businessObjectAssociations": [
      {
        "id": "435",
        "elementURI": "http://demo.smart360.biz/smartea/api/data/Isr2BoAssociation/435"
      }
    ],

… further relationships

    "elementURI": "http://demo.smart360.biz/smartea/api/data/InformationSystem/205"
  }
}

For specific queries the URl can be combined with another feature of the Enterprise Edition, the smartQL. For example to display all details of all active customer relationship management systems the according smartQL expression must be added:…/api/data/InformationSystem[@name.contains(„CRM“) & @typeOfStatus=“CURRENT“]

Complete documentation and further examples can be found in our UserGuide. Or you can start straight away testing the new functionalities in our Online-Demo.

This is a guest blog from Daniel Neuer.

1Comment

Post A Comment