Skip to content
Documentation Menu

Business Object Name

This is a template for object descriptions.

Business Object Name

General description of the business object

1. Inheritances

List all inheritors.

1.1 Inheritor #1

Describe the purpose and singularity of this inheritor.

2. Flow and Lifecycle

Describe the status of the objects, how it is created and destroyed, when and through which action it gets inherited. Name the owner. Explain the purpose.

3. Interfaces and endpoints

Explain which interfaces are available and which party should implement which one.

3.1 Interface #1

Describe the interface in detail.

Endpoint structure /xxx/yyy/

MethodDescription
GET
POST
PUT
PATCH
DELETE

Object description

Describe the structure of this object.

Primary Object

PropertyTypeCard.Description

Inheritor Object #1

If different from the primary object

PropertyTypeCard.Description

Data types

Describe all datatypes used in this object

Object Template

PropertyTypeCard.Description

Enum Template

ValueDescription