Jump to

• Request
• Response

Update Meter

put

https://server:port/ouaf/rest/apis/meter/devices/meters/{meterId}

Request

Path Parameters

• meterId(required): string

Supported Media Types

• application/xml
• application/json

Request Body - application/xml ()

Root Schema : schema

Type: object

Show Source

• armingRequired: string
  Allowed Values: [ "D1AN", "D1AR" ]

  The Arming Required Flag indicates if the device requires arming or not. Devices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected. * `D1AN` - Arming Not Required, * `D1AR` - Arming Required

  Example: D1AN
• assetId: string
  Maximum Length: 120

  Identifier Value
• badgeNumber: string
  Maximum Length: 120

  Identifier Value
• commandSet: string
  Maximum Length: 30

  Command Set
• configuration: string
  Maximum Length: 120

  Identifier Value
• deviceType: object deviceType
  Device Type provides information about the selected Device Type.
• equipment: object equipment
• externalId: string
  Maximum Length: 120

  Identifier Value
• headendElements: object headendElements
• headendRegistrationStatus: string
  Allowed Values: [ "D1DR", "D1NR", "D1RE" ]

  A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - Registered

  Example: D1DR
• incomingDataShift: string
  Allowed Values: [ "D1NS", "D1SH" ]

  Incoming Data Shift: D1NS - Always in Standard Time, D1SH - Always in Local Time * `D1NS` - Always in Standard Time, * `D1SH` - Always in Local Time
• internalMeterNumber: string
  Maximum Length: 120

  Identifier Value
• manufacturer: object manufacturer
  Manufacturer is the meter device manufacturer.
• mdmExternalId: string
  Maximum Length: 120

  Identifier Value
• meterId: string
  Maximum Length: 12

  Meter ID is a system-assigned random number that stays with a meter for life.
• model: string
  Maximum Length: 30

  Model
• nicId: string
  Maximum Length: 120

  Identifier Value
• palletNumber: string
  Maximum Length: 120

  Identifier Value
• retirementDateTime: string (date-time)
  Retirement Date Time is is when the meter device was disposed.

  Example: 2021-10-13T00:00:00-07:00
• serialNumber: string
  Maximum Length: 120

  Identifier Value
• serviceProvider: object serviceProvider
• specification: string
  Maximum Length: 120

  Identifier Value
• status: string
  Maximum Length: 12

  Status of the meter device.

  Example: ACTIVE
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Meter ID is a system-assigned random number that stays with a meter for life."
        },
        "deviceType":{
            "type":"object",
            "description":"Device Type provides information about the selected Device Type.",
            "properties":{
                "deviceType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Device Type provides information about the selected Device Type."
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the meter device.",
            "example":"ACTIVE"
        },
        "manufacturer":{
            "type":"object",
            "description":"Manufacturer is the meter device manufacturer.",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Manufacturer is the meter device manufacturer.",
                    "example":"ITRON"
                }
            }
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"Model"
        },
        "incomingDataShift":{
            "type":"string",
            "enum":[
                "D1NS",
                "D1SH"
            ],
            "description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"
        },
        "armingRequired":{
            "type":"string",
            "enum":[
                "D1AN",
                "D1AR"
            ],
            "description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required",
            "example":"D1AN"
        },
        "serviceProvider":{
            "type":"object",
            "properties":{
                "serviceProvider":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service Provider"
                }
            }
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "internalMeterNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "palletNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "externalId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "nicId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "assetId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "retirementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Retirement Date Time is is when the meter device was disposed.",
            "example":"2021-10-13T00:00:00-07:00"
        },
        "specification":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "configuration":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "headendElements":{
            "type":"object",
            "properties":{
                "automatedTopologyManagementMode":{
                    "type":"string",
                    "enum":[
                        "D4AC",
                        "D4MN"
                    ],
                    "description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual",
                    "example":"D4AC"
                },
                "neuronId":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                },
                "objectID":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Object ID"
                },
                "firmwareVersion":{
                    "type":"string",
                    "maxLength":18,
                    "description":"Version of firmware operating on the device for smart meters."
                },
                "utilDeviceID":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                },
                "NICSerialNumber":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                }
            }
        },
        "headendRegistrationStatus":{
            "type":"string",
            "enum":[
                "D1DR",
                "D1NR",
                "D1RE"
            ],
            "description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
            "example":"D1DR"
        },
        "commandSet":{
            "type":"string",
            "maxLength":30,
            "description":"Command  Set"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "equipment":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "equipmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Equipment ID"
                                    }
                                }
                            },
                            "attachDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Installation Date/Time"
                            },
                            "measuringComponent":{
                                "type":"object",
                                "properties":{
                                    "measuringComponentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Measuring Component ID"
                                    }
                                }
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments"
                            },
                            "detachDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Removal Date/Time"
                            },
                            "crew":{
                                "type":"string",
                                "maxLength":1073741824,
                                "description":"Crew that performed the installation."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-Meter"
    }
}

Nested Schema : deviceType

Type: object

Device Type provides information about the selected Device Type.

Show Source

• deviceType: string
  Maximum Length: 30

  Device Type provides information about the selected Device Type.

{
    "type":"object",
    "description":"Device Type provides information about the selected Device Type.",
    "properties":{
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type provides information about the selected Device Type."
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "equipmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Equipment ID"
                            }
                        }
                    },
                    "attachDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Installation Date/Time"
                    },
                    "measuringComponent":{
                        "type":"object",
                        "properties":{
                            "measuringComponentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Measuring Component ID"
                            }
                        }
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments"
                    },
                    "detachDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Removal Date/Time"
                    },
                    "crew":{
                        "type":"string",
                        "maxLength":1073741824,
                        "description":"Crew that performed the installation."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : headendElements

Type: object

Show Source

• automatedTopologyManagementMode: string
  Allowed Values: [ "D4AC", "D4MN" ]

  Automated Topology Management mode: D4AC - Automatic, D4MN - Manual * `D4AC` - Automatic, * `D4MN` - Manual

  Example: D4AC
• firmwareVersion: string
  Maximum Length: 18

  Version of firmware operating on the device for smart meters.
• neuronId: string
  Maximum Length: 120

  Identifier Value
• NICSerialNumber: string
  Maximum Length: 120

  Identifier Value
• objectID: string
  Maximum Length: 100

  Object ID
• utilDeviceID: string
  Maximum Length: 120

  Identifier Value

{
    "type":"object",
    "properties":{
        "automatedTopologyManagementMode":{
            "type":"string",
            "enum":[
                "D4AC",
                "D4MN"
            ],
            "description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual",
            "example":"D4AC"
        },
        "neuronId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "objectID":{
            "type":"string",
            "maxLength":100,
            "description":"Object ID"
        },
        "firmwareVersion":{
            "type":"string",
            "maxLength":18,
            "description":"Version of firmware operating on the device for smart meters."
        },
        "utilDeviceID":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "NICSerialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        }
    }
}

Nested Schema : manufacturer

Type: object

Manufacturer is the meter device manufacturer.

Show Source

• manufacturer: string
  Maximum Length: 30

  Manufacturer is the meter device manufacturer.

  Example: ITRON

{
    "type":"object",
    "description":"Manufacturer is the meter device manufacturer.",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"Manufacturer is the meter device manufacturer.",
            "example":"ITRON"
        }
    }
}

Nested Schema : serviceProvider

Type: object

Show Source

• serviceProvider: string
  Maximum Length: 30

  Service Provider

{
    "type":"object",
    "properties":{
        "serviceProvider":{
            "type":"string",
            "maxLength":30,
            "description":"Service Provider"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "equipmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Equipment ID"
                    }
                }
            },
            "attachDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Installation Date/Time"
            },
            "measuringComponent":{
                "type":"object",
                "properties":{
                    "measuringComponentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Measuring Component ID"
                    }
                }
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments"
            },
            "detachDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Removal Date/Time"
            },
            "crew":{
                "type":"string",
                "maxLength":1073741824,
                "description":"Crew that performed the installation."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attachDateTime: string (date-time)
  Installation Date/Time
• comments: string
  Maximum Length: 254

  Comments
• crew: string
  Maximum Length: 1073741824

  Crew that performed the installation.
• detachDateTime: string (date-time)
  Removal Date/Time
• equipment: object equipment
• measuringComponent: object measuringComponent
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "equipmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Equipment ID"
                }
            }
        },
        "attachDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time"
        },
        "measuringComponent":{
            "type":"object",
            "properties":{
                "measuringComponentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Measuring Component ID"
                }
            }
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "detachDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Removal Date/Time"
        },
        "crew":{
            "type":"string",
            "maxLength":1073741824,
            "description":"Crew that performed the installation."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• equipmentId: string
  Maximum Length: 12

  Equipment ID

{
    "type":"object",
    "properties":{
        "equipmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Equipment ID"
        }
    }
}

Nested Schema : measuringComponent

Type: object

Show Source

• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID"
        }
    }
}

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• armingRequired: string
  Allowed Values: [ "D1AN", "D1AR" ]

  The Arming Required Flag indicates if the device requires arming or not. Devices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected. * `D1AN` - Arming Not Required, * `D1AR` - Arming Required

  Example: D1AN
• assetId: string
  Maximum Length: 120

  Identifier Value
• badgeNumber: string
  Maximum Length: 120

  Identifier Value
• commandSet: string
  Maximum Length: 30

  Command Set
• configuration: string
  Maximum Length: 120

  Identifier Value
• deviceType: object deviceType
  Device Type provides information about the selected Device Type.
• equipment: object equipment
• externalId: string
  Maximum Length: 120

  Identifier Value
• headendElements: object headendElements
• headendRegistrationStatus: string
  Allowed Values: [ "D1DR", "D1NR", "D1RE" ]

  A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - Registered

  Example: D1DR
• incomingDataShift: string
  Allowed Values: [ "D1NS", "D1SH" ]

  Incoming Data Shift: D1NS - Always in Standard Time, D1SH - Always in Local Time * `D1NS` - Always in Standard Time, * `D1SH` - Always in Local Time
• internalMeterNumber: string
  Maximum Length: 120

  Identifier Value
• manufacturer: object manufacturer
  Manufacturer is the meter device manufacturer.
• mdmExternalId: string
  Maximum Length: 120

  Identifier Value
• meterId: string
  Maximum Length: 12

  Meter ID is a system-assigned random number that stays with a meter for life.
• model: string
  Maximum Length: 30

  Model
• nicId: string
  Maximum Length: 120

  Identifier Value
• palletNumber: string
  Maximum Length: 120

  Identifier Value
• retirementDateTime: string (date-time)
  Retirement Date Time is is when the meter device was disposed.

  Example: 2021-10-13T00:00:00-07:00
• serialNumber: string
  Maximum Length: 120

  Identifier Value
• serviceProvider: object serviceProvider
• specification: string
  Maximum Length: 120

  Identifier Value
• status: string
  Maximum Length: 12

  Status of the meter device.

  Example: ACTIVE
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Meter ID is a system-assigned random number that stays with a meter for life."
        },
        "deviceType":{
            "type":"object",
            "description":"Device Type provides information about the selected Device Type.",
            "properties":{
                "deviceType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Device Type provides information about the selected Device Type."
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the meter device.",
            "example":"ACTIVE"
        },
        "manufacturer":{
            "type":"object",
            "description":"Manufacturer is the meter device manufacturer.",
            "properties":{
                "manufacturer":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Manufacturer is the meter device manufacturer.",
                    "example":"ITRON"
                }
            }
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"Model"
        },
        "incomingDataShift":{
            "type":"string",
            "enum":[
                "D1NS",
                "D1SH"
            ],
            "description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"
        },
        "armingRequired":{
            "type":"string",
            "enum":[
                "D1AN",
                "D1AR"
            ],
            "description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required",
            "example":"D1AN"
        },
        "serviceProvider":{
            "type":"object",
            "properties":{
                "serviceProvider":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service Provider"
                }
            }
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "internalMeterNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "palletNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "externalId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "nicId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "assetId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "retirementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Retirement Date Time is is when the meter device was disposed.",
            "example":"2021-10-13T00:00:00-07:00"
        },
        "specification":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "configuration":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "headendElements":{
            "type":"object",
            "properties":{
                "automatedTopologyManagementMode":{
                    "type":"string",
                    "enum":[
                        "D4AC",
                        "D4MN"
                    ],
                    "description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual",
                    "example":"D4AC"
                },
                "neuronId":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                },
                "objectID":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Object ID"
                },
                "firmwareVersion":{
                    "type":"string",
                    "maxLength":18,
                    "description":"Version of firmware operating on the device for smart meters."
                },
                "utilDeviceID":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                },
                "NICSerialNumber":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                }
            }
        },
        "headendRegistrationStatus":{
            "type":"string",
            "enum":[
                "D1DR",
                "D1NR",
                "D1RE"
            ],
            "description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
            "example":"D1DR"
        },
        "commandSet":{
            "type":"string",
            "maxLength":30,
            "description":"Command  Set"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "equipment":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "equipmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Equipment ID"
                                    }
                                }
                            },
                            "attachDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Installation Date/Time"
                            },
                            "measuringComponent":{
                                "type":"object",
                                "properties":{
                                    "measuringComponentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Measuring Component ID"
                                    }
                                }
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments"
                            },
                            "detachDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Removal Date/Time"
                            },
                            "crew":{
                                "type":"string",
                                "maxLength":1073741824,
                                "description":"Crew that performed the installation."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-Meter"
    }
}

Nested Schema : deviceType

Type: object

Device Type provides information about the selected Device Type.

Show Source

• deviceType: string
  Maximum Length: 30

  Device Type provides information about the selected Device Type.

{
    "type":"object",
    "description":"Device Type provides information about the selected Device Type.",
    "properties":{
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type provides information about the selected Device Type."
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "equipmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Equipment ID"
                            }
                        }
                    },
                    "attachDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Installation Date/Time"
                    },
                    "measuringComponent":{
                        "type":"object",
                        "properties":{
                            "measuringComponentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Measuring Component ID"
                            }
                        }
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments"
                    },
                    "detachDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Removal Date/Time"
                    },
                    "crew":{
                        "type":"string",
                        "maxLength":1073741824,
                        "description":"Crew that performed the installation."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : headendElements

Type: object

Show Source

• automatedTopologyManagementMode: string
  Allowed Values: [ "D4AC", "D4MN" ]

  Automated Topology Management mode: D4AC - Automatic, D4MN - Manual * `D4AC` - Automatic, * `D4MN` - Manual

  Example: D4AC
• firmwareVersion: string
  Maximum Length: 18

  Version of firmware operating on the device for smart meters.
• neuronId: string
  Maximum Length: 120

  Identifier Value
• NICSerialNumber: string
  Maximum Length: 120

  Identifier Value
• objectID: string
  Maximum Length: 100

  Object ID
• utilDeviceID: string
  Maximum Length: 120

  Identifier Value

{
    "type":"object",
    "properties":{
        "automatedTopologyManagementMode":{
            "type":"string",
            "enum":[
                "D4AC",
                "D4MN"
            ],
            "description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual",
            "example":"D4AC"
        },
        "neuronId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "objectID":{
            "type":"string",
            "maxLength":100,
            "description":"Object ID"
        },
        "firmwareVersion":{
            "type":"string",
            "maxLength":18,
            "description":"Version of firmware operating on the device for smart meters."
        },
        "utilDeviceID":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "NICSerialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        }
    }
}

Nested Schema : manufacturer

Type: object

Manufacturer is the meter device manufacturer.

Show Source

• manufacturer: string
  Maximum Length: 30

  Manufacturer is the meter device manufacturer.

  Example: ITRON

{
    "type":"object",
    "description":"Manufacturer is the meter device manufacturer.",
    "properties":{
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"Manufacturer is the meter device manufacturer.",
            "example":"ITRON"
        }
    }
}

Nested Schema : serviceProvider

Type: object

Show Source

• serviceProvider: string
  Maximum Length: 30

  Service Provider

{
    "type":"object",
    "properties":{
        "serviceProvider":{
            "type":"string",
            "maxLength":30,
            "description":"Service Provider"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "equipmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Equipment ID"
                    }
                }
            },
            "attachDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Installation Date/Time"
            },
            "measuringComponent":{
                "type":"object",
                "properties":{
                    "measuringComponentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Measuring Component ID"
                    }
                }
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments"
            },
            "detachDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Removal Date/Time"
            },
            "crew":{
                "type":"string",
                "maxLength":1073741824,
                "description":"Crew that performed the installation."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attachDateTime: string (date-time)
  Installation Date/Time
• comments: string
  Maximum Length: 254

  Comments
• crew: string
  Maximum Length: 1073741824

  Crew that performed the installation.
• detachDateTime: string (date-time)
  Removal Date/Time
• equipment: object equipment
• measuringComponent: object measuringComponent
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "equipmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Equipment ID"
                }
            }
        },
        "attachDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time"
        },
        "measuringComponent":{
            "type":"object",
            "properties":{
                "measuringComponentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Measuring Component ID"
                }
            }
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "detachDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Removal Date/Time"
        },
        "crew":{
            "type":"string",
            "maxLength":1073741824,
            "description":"Crew that performed the installation."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• equipmentId: string
  Maximum Length: 12

  Equipment ID

{
    "type":"object",
    "properties":{
        "equipmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Equipment ID"
        }
    }
}

Nested Schema : measuringComponent

Type: object

Show Source

• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID

{
    "type":"object",
    "properties":{
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

Success response

Body ()

Root Schema : D1-Meter

Type: object

Show Source

• _self: string
  _self
• armingRequired: string
  Allowed Values: [ "D1AN", "D1AR" ]

  The Arming Required Flag indicates if the device requires arming or not. Devices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected. * `D1AN` - Arming Not Required, * `D1AR` - Arming Required

  Example: D1AN
• assetId: string
  Maximum Length: 120

  Identifier Value
• badgeNumber: string
  Maximum Length: 120

  Identifier Value
• commandSet: string
  Maximum Length: 30

  Command Set
• configuration: string
  Maximum Length: 120

  Identifier Value
• creationDateTime: string (date-time)
  Create Date/Time

  Example: 2020-06-03T00:01:34-07:00
• deviceType: object deviceType
  Device Type provides information about the selected Device Type.
• equipment: object equipment
• externalId: string
  Maximum Length: 120

  Identifier Value
• headendElements: object headendElements
• headendRegistrationStatus: string
  Allowed Values: [ "D1DR", "D1NR", "D1RE" ]

  A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system. * `D1DR` - Deregistered, * `D1NR` - Not Registered, * `D1RE` - Registered

  Example: D1DR
• incomingDataShift: string
  Allowed Values: [ "D1NS", "D1SH" ]

  Incoming Data Shift: D1NS - Always in Standard Time, D1SH - Always in Local Time * `D1NS` - Always in Standard Time, * `D1SH` - Always in Local Time
• internalMeterNumber: string
  Maximum Length: 120

  Identifier Value
• manufacturer: object manufacturer
  Manufacturer is the meter device manufacturer.
• mdmExternalId: string
  Maximum Length: 120

  Identifier Value
• meterId: string
  Maximum Length: 12

  Meter ID is a system-assigned random number that stays with a meter for life.
• model: string
  Maximum Length: 30

  Model
• nicId: string
  Maximum Length: 120

  Identifier Value
• palletNumber: string
  Maximum Length: 120

  Identifier Value
• retirementDateTime: string (date-time)
  Retirement Date Time is is when the meter device was disposed.

  Example: 2021-10-13T00:00:00-07:00
• serialNumber: string
  Maximum Length: 120

  Identifier Value
• serviceProvider: object serviceProvider
• specification: string
  Maximum Length: 120

  Identifier Value
• status: string
  Maximum Length: 12

  Status of the meter device.

  Example: ACTIVE
• statusDateTime: string (date-time)
  Status Date/Time

  Example: 2020-06-03T00:01:34-07:00
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "meterId":{
            "type":"string",
            "maxLength":12,
            "description":"Meter ID is a system-assigned random number that stays with a meter for life."
        },
        "deviceType":{
            "type":"object",
            "description":"Device Type provides information about the selected Device Type.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "deviceType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Device Type provides information about the selected Device Type."
                }
            }
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"Status of the meter device.",
            "example":"ACTIVE"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2020-06-03T00:01:34-07:00"
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2020-06-03T00:01:34-07:00"
        },
        "manufacturer":{
            "type":"object",
            "description":"Manufacturer is the meter device manufacturer.",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "manufacturer":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Manufacturer is the meter device manufacturer.",
                    "example":"ITRON"
                }
            }
        },
        "model":{
            "type":"string",
            "maxLength":30,
            "description":"Model"
        },
        "incomingDataShift":{
            "type":"string",
            "enum":[
                "D1NS",
                "D1SH"
            ],
            "description":"Incoming Data Shift:\n\n    D1NS - Always in Standard Time,\n    D1SH - Always in Local Time\n* `D1NS` - Always in Standard Time,\n* `D1SH` - Always in Local Time"
        },
        "armingRequired":{
            "type":"string",
            "enum":[
                "D1AN",
                "D1AR"
            ],
            "description":"The Arming Required Flag indicates if the device requires arming or not.\n\nDevices that require arming (those with an Arming required flag set to Arming Required) must be armed before they can be connected.\n* `D1AN` - Arming Not Required,\n* `D1AR` - Arming Required",
            "example":"D1AN"
        },
        "serviceProvider":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "serviceProvider":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Service Provider"
                }
            }
        },
        "serialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "badgeNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "internalMeterNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "palletNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "externalId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "nicId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "assetId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "retirementDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Retirement Date Time is is when the meter device was disposed.",
            "example":"2021-10-13T00:00:00-07:00"
        },
        "specification":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "configuration":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "headendElements":{
            "type":"object",
            "properties":{
                "automatedTopologyManagementMode":{
                    "type":"string",
                    "enum":[
                        "D4AC",
                        "D4MN"
                    ],
                    "description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual",
                    "example":"D4AC"
                },
                "neuronId":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                },
                "objectID":{
                    "type":"string",
                    "maxLength":100,
                    "description":"Object ID"
                },
                "firmwareVersion":{
                    "type":"string",
                    "maxLength":18,
                    "description":"Version of firmware operating on the device for smart meters."
                },
                "utilDeviceID":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                },
                "NICSerialNumber":{
                    "type":"string",
                    "maxLength":120,
                    "description":"Identifier Value"
                }
            }
        },
        "headendRegistrationStatus":{
            "type":"string",
            "enum":[
                "D1DR",
                "D1NR",
                "D1RE"
            ],
            "description":"A flag that indicates the registration status of the meter in the head-end system. This is used by smart meter commands and other processes to determine if the meter is currently registered in the head-end system.\n* `D1DR` - Deregistered,\n* `D1NR` - Not Registered,\n* `D1RE` - Registered",
            "example":"D1DR"
        },
        "commandSet":{
            "type":"string",
            "maxLength":30,
            "description":"Command  Set"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        },
        "equipment":{
            "type":"object",
            "properties":{
                "_data":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "equipment":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "equipmentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Equipment ID"
                                    }
                                }
                            },
                            "attachDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Installation Date/Time"
                            },
                            "measuringComponent":{
                                "type":"object",
                                "properties":{
                                    "_link":{
                                        "type":"string",
                                        "description":"_link"
                                    },
                                    "measuringComponentId":{
                                        "type":"string",
                                        "maxLength":12,
                                        "description":"Measuring Component ID"
                                    }
                                }
                            },
                            "comments":{
                                "type":"string",
                                "maxLength":254,
                                "description":"Comments"
                            },
                            "detachDateTime":{
                                "type":"string",
                                "format":"date-time",
                                "description":"Removal Date/Time"
                            },
                            "crew":{
                                "type":"string",
                                "maxLength":1073741824,
                                "description":"Crew that performed the installation."
                            },
                            "version":{
                                "type":"number",
                                "maximum":99999,
                                "minimum":-99999,
                                "description":"The Version number is used for internal concurrency checks.",
                                "example":"1"
                            }
                        }
                    }
                }
            }
        }
    },
    "xml":{
        "name":"D1-Meter"
    }
}

Nested Schema : deviceType

Type: object

Device Type provides information about the selected Device Type.

Show Source

• _link: string
  _link
• deviceType: string
  Maximum Length: 30

  Device Type provides information about the selected Device Type.

{
    "type":"object",
    "description":"Device Type provides information about the selected Device Type.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "deviceType":{
            "type":"string",
            "maxLength":30,
            "description":"Device Type provides information about the selected Device Type."
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• _data: array _data

{
    "type":"object",
    "properties":{
        "_data":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "equipment":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "equipmentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Equipment ID"
                            }
                        }
                    },
                    "attachDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Installation Date/Time"
                    },
                    "measuringComponent":{
                        "type":"object",
                        "properties":{
                            "_link":{
                                "type":"string",
                                "description":"_link"
                            },
                            "measuringComponentId":{
                                "type":"string",
                                "maxLength":12,
                                "description":"Measuring Component ID"
                            }
                        }
                    },
                    "comments":{
                        "type":"string",
                        "maxLength":254,
                        "description":"Comments"
                    },
                    "detachDateTime":{
                        "type":"string",
                        "format":"date-time",
                        "description":"Removal Date/Time"
                    },
                    "crew":{
                        "type":"string",
                        "maxLength":1073741824,
                        "description":"Crew that performed the installation."
                    },
                    "version":{
                        "type":"number",
                        "maximum":99999,
                        "minimum":-99999,
                        "description":"The Version number is used for internal concurrency checks.",
                        "example":"1"
                    }
                }
            }
        }
    }
}

Nested Schema : headendElements

Type: object

Show Source

• automatedTopologyManagementMode: string
  Allowed Values: [ "D4AC", "D4MN" ]

  Automated Topology Management mode: D4AC - Automatic, D4MN - Manual * `D4AC` - Automatic, * `D4MN` - Manual

  Example: D4AC
• firmwareVersion: string
  Maximum Length: 18

  Version of firmware operating on the device for smart meters.
• neuronId: string
  Maximum Length: 120

  Identifier Value
• NICSerialNumber: string
  Maximum Length: 120

  Identifier Value
• objectID: string
  Maximum Length: 100

  Object ID
• utilDeviceID: string
  Maximum Length: 120

  Identifier Value

{
    "type":"object",
    "properties":{
        "automatedTopologyManagementMode":{
            "type":"string",
            "enum":[
                "D4AC",
                "D4MN"
            ],
            "description":"Automated Topology Management mode:\n\n    D4AC - Automatic,\n    D4MN - Manual\n* `D4AC` - Automatic,\n* `D4MN` - Manual",
            "example":"D4AC"
        },
        "neuronId":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "objectID":{
            "type":"string",
            "maxLength":100,
            "description":"Object ID"
        },
        "firmwareVersion":{
            "type":"string",
            "maxLength":18,
            "description":"Version of firmware operating on the device for smart meters."
        },
        "utilDeviceID":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        },
        "NICSerialNumber":{
            "type":"string",
            "maxLength":120,
            "description":"Identifier Value"
        }
    }
}

Nested Schema : manufacturer

Type: object

Manufacturer is the meter device manufacturer.

Show Source

• _link: string
  _link
• manufacturer: string
  Maximum Length: 30

  Manufacturer is the meter device manufacturer.

  Example: ITRON

{
    "type":"object",
    "description":"Manufacturer is the meter device manufacturer.",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "manufacturer":{
            "type":"string",
            "maxLength":30,
            "description":"Manufacturer is the meter device manufacturer.",
            "example":"ITRON"
        }
    }
}

Nested Schema : serviceProvider

Type: object

Show Source

• _link: string
  _link
• serviceProvider: string
  Maximum Length: 30

  Service Provider

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "serviceProvider":{
            "type":"string",
            "maxLength":30,
            "description":"Service Provider"
        }
    }
}

Nested Schema : _data

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "equipment":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "equipmentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Equipment ID"
                    }
                }
            },
            "attachDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Installation Date/Time"
            },
            "measuringComponent":{
                "type":"object",
                "properties":{
                    "_link":{
                        "type":"string",
                        "description":"_link"
                    },
                    "measuringComponentId":{
                        "type":"string",
                        "maxLength":12,
                        "description":"Measuring Component ID"
                    }
                }
            },
            "comments":{
                "type":"string",
                "maxLength":254,
                "description":"Comments"
            },
            "detachDateTime":{
                "type":"string",
                "format":"date-time",
                "description":"Removal Date/Time"
            },
            "crew":{
                "type":"string",
                "maxLength":1073741824,
                "description":"Crew that performed the installation."
            },
            "version":{
                "type":"number",
                "maximum":99999,
                "minimum":-99999,
                "description":"The Version number is used for internal concurrency checks.",
                "example":"1"
            }
        }
    }
}

Nested Schema : items

Type: object

Show Source

• attachDateTime: string (date-time)
  Installation Date/Time
• comments: string
  Maximum Length: 254

  Comments
• crew: string
  Maximum Length: 1073741824

  Crew that performed the installation.
• detachDateTime: string (date-time)
  Removal Date/Time
• equipment: object equipment
• measuringComponent: object measuringComponent
• version: number
  Minimum Value: -99999

  Maximum Value: 99999

  The Version number is used for internal concurrency checks.

  Example: 1

{
    "type":"object",
    "properties":{
        "equipment":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "equipmentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Equipment ID"
                }
            }
        },
        "attachDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Installation Date/Time"
        },
        "measuringComponent":{
            "type":"object",
            "properties":{
                "_link":{
                    "type":"string",
                    "description":"_link"
                },
                "measuringComponentId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Measuring Component ID"
                }
            }
        },
        "comments":{
            "type":"string",
            "maxLength":254,
            "description":"Comments"
        },
        "detachDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Removal Date/Time"
        },
        "crew":{
            "type":"string",
            "maxLength":1073741824,
            "description":"Crew that performed the installation."
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"1"
        }
    }
}

Nested Schema : equipment

Type: object

Show Source

• _link: string
  _link
• equipmentId: string
  Maximum Length: 12

  Equipment ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "equipmentId":{
            "type":"string",
            "maxLength":12,
            "description":"Equipment ID"
        }
    }
}

Nested Schema : measuringComponent

Type: object

Show Source

• _link: string
  _link
• measuringComponentId: string
  Maximum Length: 12

  Measuring Component ID

{
    "type":"object",
    "properties":{
        "_link":{
            "type":"string",
            "description":"_link"
        },
        "measuringComponentId":{
            "type":"string",
            "maxLength":12,
            "description":"Measuring Component ID"
        }
    }
}

400 Response

Bad Request

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

500 Response

Internal Server Error

Body ()

Root Schema : problemDetailDocument

Type: object

Show Source

• detail: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• httpStatus: number
  Minimum Value: 0

  Maximum Value: 9999

  The HTTP Status code for the error.
• problemInstance: string
  Maximum Length: 60

  Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction.
• problemType: string
  Maximum Length: 60

  URL of the format "A/message/X/Y" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework.
• serverMessage: object serverMessage
• stackTrace: string
  Maximum Length: 60

  The stack trace shows where the error occurs during the execution of a program.
• title: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.

{
    "type":"object",
    "properties":{
        "problemType":{
            "type":"string",
            "maxLength":60,
            "description":"URL of the format \"A/message/X/Y\" where A is the base URI, X is the Message Category and Y is the Message Number within Oracle Utilities Application Framework."
        },
        "title":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "httpStatus":{
            "type":"number",
            "maximum":9999,
            "minimum":0,
            "description":"The HTTP Status code for the error."
        },
        "detail":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        },
        "problemInstance":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified URL consisting of the Base URI Timestamp of error in ISO format, the User used for the transaction, the Message Category within Oracle Utilities Application Framework, the Message Number within Oracle Utilities Application Framework, the Request URL and the HTTP method used for the transaction."
        },
        "stackTrace":{
            "type":"string",
            "maxLength":60,
            "description":"The stack trace shows where the error occurs during the execution of a program."
        },
        "serverMessage":{
            "type":"object",
            "properties":{
                "messageCategory":{
                    "type":"number",
                    "maximum":0,
                    "minimum":0,
                    "description":"Message Category within Oracle Utilities Application Framework."
                },
                "messageNbr":{
                    "type":"number",
                    "maximum":99999,
                    "minimum":-99999,
                    "description":"Message Number within Oracle Utilities Application Framework."
                },
                "callSequence":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Delimited sequence of programs called."
                },
                "programName":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Name of the program that encountered the error."
                },
                "messageText":{
                    "type":"string",
                    "maxLength":60,
                    "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
                },
                "longDescription":{
                    "type":"string",
                    "maxLength":60,
                    "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
                }
            }
        }
    }
}

Nested Schema : serverMessage

Type: object

Show Source

• callSequence: string
  Maximum Length: 60

  Delimited sequence of programs called.
• longDescription: string
  Maximum Length: 60

  The long message description from the Oracle Utilities Application Framework in CDATA format.
• messageCategory: number
  Minimum Value: 0

  Maximum Value: 0

  Message Category within Oracle Utilities Application Framework.
• messageNbr: number
  Minimum Value: -99999

  Maximum Value: 99999

  Message Number within Oracle Utilities Application Framework.
• messageText: string
  Maximum Length: 60

  Fully qualified error message from Oracle Utilities Application Framework in CDATA format.
• programName: string
  Maximum Length: 60

  Name of the program that encountered the error.

{
    "type":"object",
    "properties":{
        "messageCategory":{
            "type":"number",
            "maximum":0,
            "minimum":0,
            "description":"Message Category within Oracle Utilities Application Framework."
        },
        "messageNbr":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"Message Number within Oracle Utilities Application Framework."
        },
        "callSequence":{
            "type":"string",
            "maxLength":60,
            "description":"Delimited sequence of programs called."
        },
        "programName":{
            "type":"string",
            "maxLength":60,
            "description":"Name of the program that encountered the error."
        },
        "messageText":{
            "type":"string",
            "maxLength":60,
            "description":"Fully qualified error message from Oracle Utilities Application Framework in CDATA format."
        },
        "longDescription":{
            "type":"string",
            "maxLength":60,
            "description":"The long message description from the Oracle Utilities Application Framework in CDATA format."
        }
    }
}

Back to Top