CDP 4 User Manual

CDP4 Web API Introduction

The CDP4 Web API is an implementation of ECSS-E-TM-10-25 Annex C2. The CDP4 Web API is used to retrieve and update data from and to the CDP4 WebServices. This documentation describes CDP Web API as a vanilla ECSS-E-TM-10-25 Annex C2 implementation and does not take any of the CDP4 specific enhancements.

The CDP4 Web API makes use of a HTTP JSON REST interface. In order to retrieve data the GET verb is used. In order to create, update and delete data the POST verb is used.

The CDP4 Web API follows the containment of classes as modelled in the formal CDP4 UML model. Two classes in the model are so-called TopContainers, any URI on the CDP4 Web API starts with on of these two classes. The following two classes derive from TopContainer.

The SiteDirectory class is a special class, it is a singleton. Only one instance of a SiteDirectory exists on a CDP4 Server. This class represents a directory (e.g. a concept similar to a phone book or the yellow pages) that contains all the information required to:

The EngineeringModel class is not a singleton. One instance of the CDP4 WebServices may contain zero or more EngineeringModels.

Last modified 4 years ago.

^ Top