Document Properties
Last Modified04-Feb-2020
Added to KB01-Oct-2014
Public AccessEveryone
Doc TypeGuidelines, Concepts & Cookbooks
  • Intershop Studio 4.2
  • Intershop Studio 4.3
  • Intershop Studio 4.4
  • Intershop Studio 4.5
  • ICM 7.7
  • ICM 7.8
  • ICM 7.9
  • ICM 7.10

Guide - API Models

Product Version


Product To Version




1 Introduction

This guide is addressed to developers who want to make use of Intershop Studio's API tooling.

The core of the whole API tooling are API models. These are created either implicitely when using the API tooling in Intershop Studio or explicitely via exports.

1.1 Glossary

EMFEclipse Modeling Framework

2 Export

This section describes how to create persisted API model files with Intershop Studio. Technically API models are persisted as zipped EMF resources, but the user does not have to care about such details.

2.1 Intershop Studio UI

Option #1

  1. Select the cartridges to export in the Cartridge Explorer.
  2. Right-click to open the context menu.  
  3. SelectExport | Cartridge API...

Option #2

  1. Invoke File | Export...
  2. Select / de-select cartridges and click  Next >. (optional)
  3. Select Generate API HTML Documentation and click Next >.
  4. Enter an output location and click Finish.
  5. Navigate to the output location and open the generated API files (optional).

2.2 Command-line Application

Use ID api.export.model.

3 View Exported API Model

The exported API model can be opened with the API Model Editor that shows the API model in a tree view. Together with the Properties view this editor can be used for having a closer look onto the API.

  1. Select the API file
  2. Right-click to open the context menu.
  3. Select Open With | API Model Editor.
  4. Browse the API model.


The information provided in the Knowledge Base may not be applicable to all systems and situations. Intershop Communications will not be liable to any party for any direct or indirect damages resulting from the use of the Customer Support section of the Intershop Corporate Web site, including, without limitation, any lost profits, business interruption, loss of programs or other data on your information handling system.

Customer Support
Knowledge Base
Product Resources