Update Device Configuration
put
https://server:port/ouaf/rest/apis/meter/devices/deviceConfigurations/{deviceConfigurationId}
This operation handles the Integration Suite API to Update Device Configuration Operation of the D1-DeviceConfiguration REST service.
Request
Path Parameters
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
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/TimeExample:
2021-08-07T00:11:59-07:00
-
externalId: string
Maximum Length:
254
Adhoc Characteristic Value -
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
itemId: string
Maximum Length:
12
Device ID -
mdmExternalId: string
Maximum Length:
254
Adhoc Characteristic Value -
meterId: string
Maximum Length:
12
Device ID -
status: string
Maximum Length:
12
The current status of the device configuration.Example:Active
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
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
Nested Schema : deviceConfigurationType
Type:
object
Type of device configuration
Show Source
-
deviceConfigurationType: string
Maximum Length:
30
Type of device configurationExample:ZZ-STMT-CFGZ13
Nested Schema : statusReason
Type:
object
Status Reason indicates the reason for status change of the device configuration.
Show Source
-
statusReason: string
Maximum Length:
30
Status Reason indicates the reason for status change of the device configuration.
Nested Schema : timeZone
Type:
object
Enter the Time Zone in which the premise is located.
Show Source
-
timeZone: string
Maximum Length:
10
Enter the Time Zone in which the premise is located.Example:USPACIFIC
Root Schema : schema
Type:
Show Source
object
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
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/TimeExample:
2021-08-07T00:11:59-07:00
-
externalId: string
Maximum Length:
254
Adhoc Characteristic Value -
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
itemId: string
Maximum Length:
12
Device ID -
mdmExternalId: string
Maximum Length:
254
Adhoc Characteristic Value -
meterId: string
Maximum Length:
12
Device ID -
status: string
Maximum Length:
12
The current status of the device configuration.Example:Active
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
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
Nested Schema : deviceConfigurationType
Type:
object
Type of device configuration
Show Source
-
deviceConfigurationType: string
Maximum Length:
30
Type of device configurationExample:ZZ-STMT-CFGZ13
Nested Schema : statusReason
Type:
object
Status Reason indicates the reason for status change of the device configuration.
Show Source
-
statusReason: string
Maximum Length:
30
Status Reason indicates the reason for status change of the device configuration.
Nested Schema : timeZone
Type:
object
Enter the Time Zone in which the premise is located.
Show Source
-
timeZone: string
Maximum Length:
10
Enter the Time Zone in which the premise is located.Example:USPACIFIC
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1-DevConf
Type:
Show Source
object
-
_self: string
_self
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2021-07-23T08:44:51-07:00
-
device: object
device
-
deviceConfigurationType: object
deviceConfigurationType
Type of device configuration
-
effectiveDateTime: string
(date-time)
Effective Date/TimeExample:
2021-08-07T00:11:59-07:00
-
externalId: string
Maximum Length:
254
Adhoc Characteristic Value -
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:GET
-
itemId: string
Maximum Length:
12
Device ID -
mdmExternalId: string
Maximum Length:
254
Adhoc Characteristic Value -
meterId: string
Maximum Length:
12
Device ID -
status: string
Maximum Length:
12
The current status of the device configuration.Example:Active
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
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
Nested Schema : device
Type:
Show Source
object
-
_link: string
_link
-
deviceId: string
Maximum Length:
12
Device ID
Nested Schema : deviceConfigurationType
Type:
object
Type of device configuration
Show Source
-
_link: string
_link
-
deviceConfigurationType: string
Maximum Length:
30
Type of device configurationExample:ZZ-STMT-CFGZ13
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.
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
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.