Update Item
put
https://server:port/spl/rest/apis/meter/devices/items/{itemId}
Request
Path Parameters
-
itemId(required): string
The Device or meter identifier in the source system.Example:
881940890969
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
assetId: string
Maximum Length:
120
The device identifier for the Asset ID.Example:LP3211
-
badgeNumber: string
Maximum Length:
120
The device identifier for the Badge Number.Example:32505964
-
boStatus: string
Maximum Length:
12
Status of the item deviceExample:ACTIVE
-
configuration: string
Maximum Length:
120
Configuration is the type of configurationExample:Badged Item KW
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2020-10-12T22:35:28-07:00
-
externalId: string
Maximum Length:
60
External identifier for the item device.Example:29256350
-
internalNumber: string
Maximum Length:
120
The device identifier value for the internal number.Example:I-20140306001
-
itemId: string
Maximum Length:
12
The Device or meter identifier in the source system.Example:881940890969
-
itemType: object
itemType
-
manufacturer: object
manufacturer
The Manufacturer of the device.
-
mdmExternalId: string
Maximum Length:
60
MDM External ID for the item device.Example:32505964
-
model: string
Maximum Length:
30
The specific model number of the device provided by the manufacturer.Example:ELECTRIC 4
-
retirementDateTime: string
(date-time)
Retirement Date/TimeExample:
2020-10-13T00:00:00-07:00
-
serialNumber: string
Maximum Length:
120
The device identifier for the Serial Number.Example:SV100-60012
-
specification: string
Maximum Length:
120
Specifications are used to define the manufacturer, model, and other information about the template device.Example:BIT_01
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2020-10-13T02:16:42-07:00
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:5
Nested Schema : manufacturer
Type:
object
The Manufacturer of the device.
Show Source
-
manufacturer: string
Maximum Length:
30
The Manufacturer of the device.Example:GE
Root Schema : schema
Type:
Show Source
object
-
assetId: string
Maximum Length:
120
The device identifier for the Asset ID.Example:LP3211
-
badgeNumber: string
Maximum Length:
120
The device identifier for the Badge Number.Example:32505964
-
boStatus: string
Maximum Length:
12
Status of the item deviceExample:ACTIVE
-
configuration: string
Maximum Length:
120
Configuration is the type of configurationExample:Badged Item KW
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2020-10-12T22:35:28-07:00
-
externalId: string
Maximum Length:
60
External identifier for the item device.Example:29256350
-
internalNumber: string
Maximum Length:
120
The device identifier value for the internal number.Example:I-20140306001
-
itemId: string
Maximum Length:
12
The Device or meter identifier in the source system.Example:881940890969
-
itemType: object
itemType
-
manufacturer: object
manufacturer
The Manufacturer of the device.
-
mdmExternalId: string
Maximum Length:
60
MDM External ID for the item device.Example:32505964
-
model: string
Maximum Length:
30
The specific model number of the device provided by the manufacturer.Example:ELECTRIC 4
-
retirementDateTime: string
(date-time)
Retirement Date/TimeExample:
2020-10-13T00:00:00-07:00
-
serialNumber: string
Maximum Length:
120
The device identifier for the Serial Number.Example:SV100-60012
-
specification: string
Maximum Length:
120
Specifications are used to define the manufacturer, model, and other information about the template device.Example:BIT_01
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2020-10-13T02:16:42-07:00
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:5
Nested Schema : manufacturer
Type:
object
The Manufacturer of the device.
Show Source
-
manufacturer: string
Maximum Length:
30
The Manufacturer of the device.Example:GE
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1-Item
Type:
Show Source
object
-
_self: string
_self
-
assetId: string
Maximum Length:
120
The device identifier for the Asset ID.Example:LP3211
-
badgeNumber: string
Maximum Length:
120
The device identifier for the Badge Number.Example:32505964
-
boStatus: string
Maximum Length:
12
Status of the item deviceExample:ACTIVE
-
configuration: string
Maximum Length:
120
Configuration is the type of configurationExample:Badged Item KW
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2020-10-12T22:35:28-07:00
-
externalId: string
Maximum Length:
60
External identifier for the item device.Example:29256350
-
internalNumber: string
Maximum Length:
120
The device identifier value for the internal number.Example:I-20140306001
-
itemId: string
Maximum Length:
12
The Device or meter identifier in the source system.Example:881940890969
-
itemType: object
itemType
-
manufacturer: object
manufacturer
The Manufacturer of the device.
-
mdmExternalId: string
Maximum Length:
60
MDM External ID for the item device.Example:32505964
-
model: string
Maximum Length:
30
The specific model number of the device provided by the manufacturer.Example:ELECTRIC 4
-
retirementDateTime: string
(date-time)
Retirement Date/TimeExample:
2020-10-13T00:00:00-07:00
-
serialNumber: string
Maximum Length:
120
The device identifier for the Serial Number.Example:SV100-60012
-
specification: string
Maximum Length:
120
Specifications are used to define the manufacturer, model, and other information about the template device.Example:BIT_01
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2020-10-13T02:16:42-07:00
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:5
Nested Schema : itemType
Type:
Show Source
object
-
_link: string
_link
-
deviceType: string
Maximum Length:
30
Device Type
Nested Schema : manufacturer
Type:
object
The Manufacturer of the device.
Show Source
-
_link: string
_link
-
manufacturer: string
Maximum Length:
30
The Manufacturer of the device.Example:GE
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.