The contract defines 10 schemas that model the data the API accepts and returns. The most detailed are Extensible (3 properties), Extensible_FVO (3 properties), Addressable (2 properties), Addressable_FVO (1 property). Each schema is shown below with its type and property counts.
Entity_FVO
object
Base entity schema for use in TMForum Open-APIs. Property.
Addressable
object
Base schema for adressable entities
2 properties
ExportJob
Error
Used when an API throws an Error, typically with a HTTP error response-code (3xx, 4xx, 5xx)
JobStateType
string
Valid values for the state of a batch job (e.g. catalog import)
Entity
object
Base entity schema for use in TMForum Open-APIs. Property.
Addressable_FVO
object
Base schema for adressable entities
1 property
Extensible
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties1 required
ExportJob_FVO
Extensible_FVO
object
Base Extensible schema for use in TMForum Open-APIs - When used for in a schema it means that the Entity described by the schema MUST be extended with the @type
3 properties1 required
Specification
The full machine-readable OpenAPI contract behind this narrative.
