FDC3/packages/fdc3-context/schemas/context/order.schema.json at f2871cc8818c3c2544196e36b9d13f135dc4e3df · Citi/FDC3 · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://fdc3.finos.org/schemas/next/context/order.schema.json",
  "type": "object",
  "title": "Order",
  "description": "@experimental context type representing an order. To be used with OMS and EMS systems.\n\nThis type currently only defines a required `id` field, which should provide a reference to the order in one or more systems, an optional human readable `name` field to be used to summarize the order and an optional `details` field that may be used to provide additional detail about the order, including a context representing a `product`, which may be extended with arbitrary properties. The `details.product` field is currently typed as a unspecified Context type, but both `details` and `details.product` are expected to be standardized in future.",
  "allOf": [
    {
      "type": "object",
      "properties": {
        "type": {
          "const": "fdc3.order"
        },
        "id": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "title": "Order Identifiers",
          "description": "One or more identifiers that refer to the order in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future."
        },
        "name": {
          "type": "string",
          "title": "Name",
          "description": "An optional human-readable summary of the order."
        },
        "details": {
          "type": "object",
          "title": "Order Details",
          "description": "Optional additional details about the order, which may include a product element that is an, as yet undefined but extensible, Context",
          "properties": {
            "product": {
              "$ref": "product.schema.json"
            }
          },
          "additionalProperties": true
        },
        "notes": {
					"type": "string",
					"title": "Order Notes",
					"description": "Additional notes or comments about the order."
				}
      },
      "required": [
        "type",
        "id"
      ],
      "additionalProperties": true
    },
    { "$ref": "context.schema.json#/definitions/BaseContext" }
  ],
  "examples": [
    {
      "type": "fdc3.order",
      "name": "...",
      "notes": "...",
      "id": {
        "myOMS": "12345"
      },
      "details": {
        "product": {
          "type": "fdc3.product",
          "id": {
            "productId": "ABC123"
          },
          "instrument": {
            "type": "fdc3.instrument",
            "id": {
              "ticker": "MSFT"
            }
          }
        }
      }
    },
    {
      "type": "fdc3.order",
      "id": {
        "myOMS": "ABC123"
      }
    }
  ]
}