Get Meter Details
get
https://server:port/ouaf/rest/apis/meter/devices/meters/{meterId}
This script handles the Integration Suite API to Get Meter Details
Request
Path Parameters
Query Parameters
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1-Meter
Type:
Show Source
object
-
_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 RequiredExample: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/TimeExample:
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` - RegisteredExample: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/TimeExample:
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
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.
Nested Schema : headendElements
Type:
Show Source
object
-
automatedTopologyManagementMode: string
Allowed Values:
[ "D4AC", "D4MN" ]
Automated Topology Management mode: D4AC - Automatic, D4MN - Manual * `D4AC` - Automatic, * `D4MN` - ManualExample: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
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
Nested Schema : serviceProvider
Type:
Show Source
object
-
_link: string
_link
-
serviceProvider: string
Maximum Length:
30
Service Provider
Nested Schema : items
Type:
Show Source
object
-
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
Nested Schema : equipment
Type:
Show Source
object
-
_link: string
_link
-
equipmentId: string
Maximum Length:
12
Equipment ID
Nested Schema : measuringComponent
Type:
Show Source
object
-
_link: string
_link
-
measuringComponentId: string
Maximum Length:
12
Measuring Component ID
400 Response
Bad Request
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.
500 Response
Internal Server Error
Root Schema : problemDetailDocument
Type:
Show Source
object
-
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.
Nested Schema : serverMessage
Type:
Show Source
object
-
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.