Create Install Event
post
https://server:port/ouaf/rest/apis/meter/v-model/installEvents/
This Operation handles the Integration Suite API to Create Install Event
Request
There are no request parameters for this operation.
Supported Media Types
- application/xml
- application/json
Root Schema : schema
Type:
Show Source
object
-
armingStatus: string
Allowed Values:
[ "D1AM", "D1NA" ]
A flag that indicates if the device has been armed or not. * `D1AM` - Armed, * `D1NA` - Not ArmedExample:D1AM
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2012-08-24T02:36:22-07:00
-
crew: string
Maximum Length:
60
Crew -
deviceConfiguration: object
deviceConfiguration
-
eventDateTime: string
(date-time)
Use Event Date / Time to define when the status changed.Example:
2021-10-22T00:00:00-11:00
-
externalId: string
Maximum Length:
60
External ID is used by external system to identify the install event.Example:12345
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:DELT
-
installationConstant: number
Minimum Value:
-999999.999999
Maximum Value:999999.999999
A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.Example:1.000000
-
installDateTime: string
(date-time)
Installation Date/Time is the date/time when the device was installed at service point.Example:
2010-01-01T00:00:00-08:00
-
installEventId: string
Maximum Length:
12
Install Event ID is a system assigned random number that stays with install event record.Example:850626819111
-
mdmExternalId: string
Maximum Length:
60
MDM External IDExample:56789
-
onOffHistory: object
onOffHistory
-
removalDateTime: string
(date-time)
Enter the Removal Date/Time showing when the device is removed from the service point.
-
removalType: string
Allowed Values:
[ "D1OE", "D1PR" ]
A flag that indicates the removal type. * `D1OE` - Office Exchange, * `D1PR` - Physical RemovalExample:D1PR
-
servicePoint: object
servicePoint
-
status: string
Maximum Length:
12
The current status of the install event.Example:DISCONN-COMM
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2012-08-24T03:49:39-07:00
-
statusReason: object
statusReason
Status Reason indicates the reason for status change of the install event.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : deviceConfiguration
Type:
Show Source
object
-
deviceConfigurationId: string
Maximum Length:
12
Device Configuration
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : statusReason
Type:
object
Status Reason indicates the reason for status change of the install event.
Show Source
-
statusReason: string
Maximum Length:
30
Status Reason indicates the reason for status change of the install event.
Nested Schema : items
Type:
Show Source
object
-
activityId: string
Maximum Length:
14
Activity ID -
deviceOnOffStatus: string
Allowed Values:
[ "D1OF", "D1ON" ]
Device On/Off Status: * `D1OF` - Off, * `D1ON` - On -
eventDateTime: string
(date-time)
Use Event Date / Time to define when the status changed.Example:
2021-10-22T00:00:00-11:00
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
A unique Sequence number is given to each entry after the information is saved.Example:1
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Root Schema : schema
Type:
Show Source
object
-
armingStatus: string
Allowed Values:
[ "D1AM", "D1NA" ]
A flag that indicates if the device has been armed or not. * `D1AM` - Armed, * `D1NA` - Not ArmedExample:D1AM
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2012-08-24T02:36:22-07:00
-
crew: string
Maximum Length:
60
Crew -
deviceConfiguration: object
deviceConfiguration
-
eventDateTime: string
(date-time)
Use Event Date / Time to define when the status changed.Example:
2021-10-22T00:00:00-11:00
-
externalId: string
Maximum Length:
60
External ID is used by external system to identify the install event.Example:12345
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:DELT
-
installationConstant: number
Minimum Value:
-999999.999999
Maximum Value:999999.999999
A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.Example:1.000000
-
installDateTime: string
(date-time)
Installation Date/Time is the date/time when the device was installed at service point.Example:
2010-01-01T00:00:00-08:00
-
installEventId: string
Maximum Length:
12
Install Event ID is a system assigned random number that stays with install event record.Example:850626819111
-
mdmExternalId: string
Maximum Length:
60
MDM External IDExample:56789
-
onOffHistory: object
onOffHistory
-
removalDateTime: string
(date-time)
Enter the Removal Date/Time showing when the device is removed from the service point.
-
removalType: string
Allowed Values:
[ "D1OE", "D1PR" ]
A flag that indicates the removal type. * `D1OE` - Office Exchange, * `D1PR` - Physical RemovalExample:D1PR
-
servicePoint: object
servicePoint
-
status: string
Maximum Length:
12
The current status of the install event.Example:DISCONN-COMM
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2012-08-24T03:49:39-07:00
-
statusReason: object
statusReason
Status Reason indicates the reason for status change of the install event.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : deviceConfiguration
Type:
Show Source
object
-
deviceConfigurationId: string
Maximum Length:
12
Device Configuration
Nested Schema : servicePoint
Type:
Show Source
object
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : statusReason
Type:
object
Status Reason indicates the reason for status change of the install event.
Show Source
-
statusReason: string
Maximum Length:
30
Status Reason indicates the reason for status change of the install event.
Nested Schema : items
Type:
Show Source
object
-
activityId: string
Maximum Length:
14
Activity ID -
deviceOnOffStatus: string
Allowed Values:
[ "D1OF", "D1ON" ]
Device On/Off Status: * `D1OF` - Off, * `D1ON` - On -
eventDateTime: string
(date-time)
Use Event Date / Time to define when the status changed.Example:
2021-10-22T00:00:00-11:00
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
A unique Sequence number is given to each entry after the information is saved.Example:1
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Response
Supported Media Types
- application/xml
- application/json
200 Response
Success response
Root Schema : D1InstallEve
Type:
Show Source
object
-
_self: string
_self
-
armingStatus: string
Allowed Values:
[ "D1AM", "D1NA" ]
A flag that indicates if the device has been armed or not. * `D1AM` - Armed, * `D1NA` - Not ArmedExample:D1AM
-
creationDateTime: string
(date-time)
Create Date/TimeExample:
2012-08-24T02:36:22-07:00
-
crew: string
Maximum Length:
60
Crew -
deviceConfiguration: object
deviceConfiguration
-
eventDateTime: string
(date-time)
Use Event Date / Time to define when the status changed.Example:
2021-10-22T00:00:00-11:00
-
externalId: string
Maximum Length:
60
External ID is used by external system to identify the install event.Example:12345
-
httpMethod: string
Allowed Values:
[ "DELT", "GET ", "POST", "PTCH", "PUT " ]
HTTP Method * `DELT` - Delete, * `GET ` - Get, * `POST` - Post, * `PTCH` - Patch, * `PUT ` - PutExample:DELT
-
installationConstant: number
Minimum Value:
-999999.999999
Maximum Value:999999.999999
A value (other than 1) used to indicate that when calculating consumption, the installation requires that measurement data be multiplied by this value to get accurate results.Example:1.000000
-
installDateTime: string
(date-time)
Installation Date/Time is the date/time when the device was installed at service point.Example:
2010-01-01T00:00:00-08:00
-
installEventId: string
Maximum Length:
12
Install Event ID is a system assigned random number that stays with install event record.Example:850626819111
-
mdmExternalId: string
Maximum Length:
60
MDM External IDExample:56789
-
onOffHistory: object
onOffHistory
-
removalDateTime: string
(date-time)
Enter the Removal Date/Time showing when the device is removed from the service point.
-
removalType: string
Allowed Values:
[ "D1OE", "D1PR" ]
A flag that indicates the removal type. * `D1OE` - Office Exchange, * `D1PR` - Physical RemovalExample:D1PR
-
servicePoint: object
servicePoint
-
status: string
Maximum Length:
12
The current status of the install event.Example:DISCONN-COMM
-
statusDateTime: string
(date-time)
Status Date/TimeExample:
2012-08-24T03:49:39-07:00
-
statusReason: object
statusReason
Status Reason indicates the reason for status change of the install event.
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
Nested Schema : deviceConfiguration
Type:
Show Source
object
-
_link: string
_link
-
deviceConfigurationId: string
Maximum Length:
12
Device Configuration
Nested Schema : servicePoint
Type:
Show Source
object
-
_link: string
_link
-
servicePointId: string
Maximum Length:
12
Service Point ID
Nested Schema : statusReason
Type:
object
Status Reason indicates the reason for status change of the install event.
Show Source
-
_link: string
_link
-
statusReason: string
Maximum Length:
30
Status Reason indicates the reason for status change of the install event.
Nested Schema : items
Type:
Show Source
object
-
activityId: string
Maximum Length:
14
Activity ID -
deviceOnOffStatus: string
Allowed Values:
[ "D1OF", "D1ON" ]
Device On/Off Status: * `D1OF` - Off, * `D1ON` - On -
eventDateTime: string
(date-time)
Use Event Date / Time to define when the status changed.Example:
2021-10-22T00:00:00-11:00
-
sequence: number
Minimum Value:
-99999
Maximum Value:99999
A unique Sequence number is given to each entry after the information is saved.Example:1
-
version: number
Minimum Value:
-99999
Maximum Value:99999
The Version number is used for internal concurrency checks.Example:1
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.