TM Forum · JSON Structure

Tmf622 Product Ordering Note Structure

Note schema from TM Forum API

Type: Properties: 0
TelcoTelecommunicationsBSSOSSOpen APIsStandards

Note is a JSON Structure definition published by TM Forum. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/tm-forum/refs/heads/main/json-structure/tmf622-product-ordering-note-structure.json",
  "name": "Note",
  "description": "Note schema from TM Forum API",
  "allOf": [
    {
      "$ref": "#/components/schemas/Extensible"
    },
    {
      "type": "object",
      "description": "Extra information about a given entity",
      "properties": {
        "id": {
          "type": "string",
          "description": "Identifier of the note within its containing entity",
          "example": "afa9-3d90aaa8da0f"
        },
        "author": {
          "type": "string",
          "description": "Author of the note",
          "example": "Mr. N. Bene"
        },
        "date": {
          "type": "datetime",
          "description": "Date of the note",
          "example": "2020-11-20T08:00:00Z"
        },
        "text": {
          "type": "string",
          "description": "Text of the note",
          "example": "This is important"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "Note": "#/components/schemas/Note"
    }
  }
}