Entity

Extends

Extensible

Base entity schema for use in TMForum Open-APIs.

Field Required Nullable Type Description Constraints Example

@type

Yes

No

String

When sub-classing, this defines the sub-class Extensible name

default null;

@baseType

No

No

String

When sub-classing, this defines the super-class

default null;

@schemaLocation

No

No

String

A URI to a JSON-Schema file that defines additional attributes and relationships

default null;

id

No

No

String

Unique identifier

default null;

2d7ed5fd-9f62-4211-bc84-357f5f7b80f5

href

No

No

URI

Hyperlink reference

default null;

https://api.example.org/resource/id