Skip to content

Usage examples

Add a new site with equipment

Goal:

  • Add 3 sites: A, B and C
  • Attach 3 equipments to site C, two with points and one with a shape.

Input JSON file:

data.json

json
[
    {
        "operation": "CREATE_SITES",
        "params": {
            "cross_operator_match_distance_m": 100
        },
        "data": [
            {
                "owner": "INFRA_01",
                "site_name": "Site A",
                "date_of_installation": "2025-01-01",
                "operator_status": "Active",
                "subpart_w_segment": "OOOOb",
                "operator_unique_id": "TS1",
                "other_operator_ids": "TS1-ALT,TESTCO-TS1",
                "geometry": "{\"type\": \"Point\",\"coordinates\": [-106.8436308791011, 34.783062571462494]}",
                "geometry_source": "OPERATOR_PROVIDED",
                "start_date": "2025-01-01",
                "end_date": "2025-12-31",
                "extra_field1": "Extra Value 1",
                "extra_field2": "Extra Value 2",
                "change_transactions": [
                    {
                        "type": "create",
                        "date": "2025-01-01"
                    }
                ],
                "site_data_source": "Import Test"
            },
            {
                "owner": "INFRA_01",
                "site_name": "Site B",
                "date_of_installation": "2025-01-01",
                "operator_status": "Active",
                "subpart_w_segment": "OOOOb",
                "operator_unique_id": "TS1",
                "other_operator_ids": "TS1-ALT,TESTCO-TS1",
                "geometry": "{\"type\": \"Point\",\"coordinates\": [-106.84455467396093, 34.78297044770471]}",
                "geometry_source": "OPERATOR_PROVIDED",
                "start_date": "2025-01-01",
                "end_date": "2025-12-31",
                "extra_field1": "Extra Value 1",
                "extra_field2": "Extra Value 2",
                "change_transactions": [
                    {
                        "type": "create",
                        "date": "2025-01-01"
                    }
                ],
                "site_data_source": "Import Test"
            },
            {
                "owner": "INFRA_01",
                "site_name": "Site C",
                "date_of_installation": "2025-01-01",
                "operator_status": "Active",
                "subpart_w_segment": "OOOOb",
                "operator_unique_id": "TS1",
                "other_operator_ids": "TS1-ALT,TESTCO-TS1",
                "geometry": "{\"type\":\"Polygon\",\"coordinates\":[[[-106.84263484835262,34.7826480137426],[-106.84259855944536,34.780919312689385],[-106.84042122501215,34.7808895071811],[-106.84043771997,34.78228764488164],[-106.84059937055669,34.78242583162337],[-106.840589473582,34.782661561413335],[-106.84263484835262,34.7826480137426]]]}",
                "geometry_source": "OPERATOR_PROVIDED",
                "start_date": "2025-01-01",
                "end_date": "2025-12-31",
                "extra_field1": "Extra Value 1",
                "extra_field2": "Extra Value 2",
                "change_transactions": [
                    {
                        "type": "create",
                        "date": "2025-01-01"
                    }
                ],
                "site_data_source": "Import Test",
                "equipment": [
                    {
                        "group_name": "",
                        "material": "Steel",
                        "fuel": "Natural Gas",
                        "equipment_class": "Compressor",
                        "equipment_sub_class": "Reciprocating",
                        "manufacturer_make": "GE",
                        "manufacturer_model": "XYZ-123",
                        "manufacturer_serial_number": "SN123456",
                        "operator_status": "Active",
                        "date_of_installation": "2023-01-01",
                        "date_of_last_modification": "2023-12-31",
                        "operator_unique_id": "COMP-001",
                        "other_operator_ids": "OLD-001",
                        "equipment_type": "EQUIPMENT",
                        "geometry": "{\"type\": \"Point\",\"coordinates\": [-106.84104739463146, 34.78220541516408]}",
                        "geometry_source": "OPERATOR_PROVIDED",
                        "start_date": "2023-01-01",
                        "end_date": null,
                        "equipment_data_source": "Manual Entry",
                        "change_transactions": [],
                        "extra_data": {}
                    },
                    {
                        "group_name": "",
                        "material": "Steel",
                        "fuel": "Natural Gas",
                        "equipment_class": "Compressor",
                        "equipment_sub_class": "Reciprocating",
                        "manufacturer_make": "GE",
                        "manufacturer_model": "XYZ-123",
                        "manufacturer_serial_number": "SN000234",
                        "operator_status": "Active",
                        "date_of_installation": "2023-01-01",
                        "date_of_last_modification": "2023-12-31",
                        "operator_unique_id": "COMP-001",
                        "other_operator_ids": "OLD-001",
                        "equipment_type": "EQUIPMENT",
                        "geometry": "{\"type\": \"Point\",\"coordinates\": [-106.84246716829732, 34.78167775336726]}",
                        "geometry_source": "OPERATOR_PROVIDED",
                        "start_date": "2023-01-01",
                        "end_date": null,
                        "equipment_data_source": "Manual Entry",
                        "change_transactions": [],
                        "extra_data": {}
                    },
                    {
                        "group_name": "",
                        "material": "Steel",
                        "fuel": "",
                        "equipment_class": "Tank Battery",
                        "equipment_sub_class": "",
                        "manufacturer_make": "",
                        "manufacturer_model": "",
                        "manufacturer_serial_number": "",
                        "operator_status": "Active",
                        "date_of_installation": "2023-01-01",
                        "date_of_last_modification": "2023-12-31",
                        "operator_unique_id": "COMP-001",
                        "other_operator_ids": "OLD-001",
                        "equipment_type": "EQUIPMENT",
                        "geometry": "{\"type\":\"Polygon\",\"coordinates\":[[[-106.84222122841749,34.782213137019106],[-106.8422180945213,34.78208443934299],[-106.84194074470639,34.78208958725384],[-106.84194387860263,34.782216997946236],[-106.84222122841749,34.782213137019106]]]}",
                        "geometry_source": "OPERATOR_PROVIDED",
                        "start_date": "2023-01-01",
                        "end_date": null,
                        "equipment_data_source": "Manual Entry",
                        "change_transactions": [],
                        "extra_data": {}
                    }
                ]
            }
        ]
    }
]

Change a site name

data.json

json
[
    {
        "operation": "UPDATE_SITES",
        "params": {},
        "data": [
            {
                "id": "3cafce13-e0fb-43ca-a65d-5abb514ff335",
                "site_name": "Site A (Well A3-DR)"
            }
        ]
    }
]

Note 1: If you change the site’s geometry attribute, the cross operator matcher will run again and alert of possible matches to other operator’s sites.