Oracle Utilities REST API for Metering and Customer Information

Get Device Configuration

get

https://server:port/spl/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}

Request

Path Parameters

deviceConfigurationId(required): string
Device Configuration ID is a system assigned random number that stays with a device configuration record.
Example:
```
099948278222
```

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success response

Root Schema : D1-DevConf

Type: object

Show Source

_self: string

_self
creationDateTime: string (date-time)

Create Date/Time

Example: 2021-07-23T08:44:51-07:00
device: object device
deviceConfigurationId: string

Maximum Length: 12

Device Configuration ID is a system assigned random number that stays with a device configuration record.

Example: 099948278222
deviceConfigurationType: object deviceConfigurationType

Type of device configuration
effectiveDateTime: string (date-time)

Effective Date/Time

Example: 2021-08-07T00:11:59-07:00
externalId: string

Maximum Length: 254

Adhoc Characteristic Value
mdmExternalId: string

Maximum Length: 254

Adhoc Characteristic Value
status: string

Maximum Length: 12

The current status of the device configuration.

Example: Active
statusDateTime: string (date-time)

Status Date/Time

Example: 2021-07-23T08:44:51-07:00
statusReason: object statusReason

Status Reason indicates the reason for status change of the device configuration.
timeZone: object timeZone

Enter the Time Zone in which the premise is located.
version: number

Minimum Value: -99999

Maximum Value: 99999

The Version number is used for internal concurrency checks.

Example: 14

{
    "type":"object",
    "properties":{
        "_self":{
            "type":"string",
            "description":"_self"
        },
        "deviceConfigurationId":{
            "type":"string",
            "maxLength":12,
            "description":"Device Configuration ID is a system assigned random number that stays with a device configuration record.",
            "example":"099948278222"
        },
        "deviceConfigurationType":{
            "type":"object",
            "description":"Type of device configuration",
            "properties":{
                "deviceConfigurationType":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Type of device configuration",
                    "example":"ZZ-STMT-CFGZ13"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "device":{
            "type":"object",
            "properties":{
                "deviceId":{
                    "type":"string",
                    "maxLength":12,
                    "description":"Device ID"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "effectiveDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Effective Date/Time",
            "example":"2021-08-07T00:11:59-07:00"
        },
        "timeZone":{
            "type":"object",
            "description":"Enter the Time Zone in which the premise is located.",
            "properties":{
                "timeZone":{
                    "type":"string",
                    "maxLength":10,
                    "description":"Enter the Time Zone in which the premise is located.",
                    "example":"USPACIFIC"
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "externalId":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "mdmExternalId":{
            "type":"string",
            "maxLength":254,
            "description":"Adhoc Characteristic Value"
        },
        "status":{
            "type":"string",
            "maxLength":12,
            "description":"The current status of the device configuration.",
            "example":"Active"
        },
        "statusDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Status Date/Time",
            "example":"2021-07-23T08:44:51-07:00"
        },
        "statusReason":{
            "type":"object",
            "description":"Status Reason indicates the reason for status change of the device configuration.",
            "properties":{
                "statusReason":{
                    "type":"string",
                    "maxLength":30,
                    "description":"Status Reason indicates the reason for status change of the device configuration."
                },
                "_link":{
                    "type":"string",
                    "description":"_link"
                }
            }
        },
        "creationDateTime":{
            "type":"string",
            "format":"date-time",
            "description":"Create Date/Time",
            "example":"2021-07-23T08:44:51-07:00"
        },
        "version":{
            "type":"number",
            "maximum":99999,
            "minimum":-99999,
            "description":"The Version number is used for internal concurrency checks.",
            "example":"14"
        }
    },
    "xml":{
        "name":"D1-DevConf"
    }
}

Nested Schema : device

Type: object

Show Source

_link: string

_link
deviceId: string

Maximum Length: 12

Device ID

{
    "type":"object",
    "properties":{
        "deviceId":{
            "type":"string",
            "maxLength":12,
            "description":"Device ID"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : deviceConfigurationType

Type: object

Type of device configuration

Show Source

_link: string

_link
deviceConfigurationType: string

Maximum Length: 30

Type of device configuration

Example: ZZ-STMT-CFGZ13

{
    "type":"object",
    "description":"Type of device configuration",
    "properties":{
        "deviceConfigurationType":{
            "type":"string",
            "maxLength":30,
            "description":"Type of device configuration",
            "example":"ZZ-STMT-CFGZ13"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : statusReason

Type: object

Status Reason indicates the reason for status change of the device configuration.

Show Source

_link: string

_link
statusReason: string

Maximum Length: 30

Status Reason indicates the reason for status change of the device configuration.

{
    "type":"object",
    "description":"Status Reason indicates the reason for status change of the device configuration.",
    "properties":{
        "statusReason":{
            "type":"string",
            "maxLength":30,
            "description":"Status Reason indicates the reason for status change of the device configuration."
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

Nested Schema : timeZone

Type: object

Enter the Time Zone in which the premise is located.

Show Source

_link: string

_link
timeZone: string

Maximum Length: 10

Enter the Time Zone in which the premise is located.

Example: USPACIFIC

{
    "type":"object",
    "description":"Enter the Time Zone in which the premise is located.",
    "properties":{
        "timeZone":{
            "type":"string",
            "maxLength":10,
            "description":"Enter the Time Zone in which the premise is located.",
            "example":"USPACIFIC"
        },
        "_link":{
            "type":"string",
            "description":"_link"
        }
    }
}

400 Response

Bad Request

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

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."
        }
    }
}