Create a meter reading

post

/fscmRestApi/resources/11.13.18.05/meterReadings

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Unique identifier of an asset. Either the asset number or asset identifier is required for a new reading. When the asset identifier is provided with the meter identifier, it's used to identify an individual asset meter and record a new meter reading. Alternatively, the meter code and asset number may be used to identify an individual asset meter and record a new meter reading.
  • Unique number of an asset. Either the asset number or asset identifier is required for a new reading. When the asset number is provided with the meter code, it's used to identify an individual asset meter and record a new meter reading. Alternatively, the meter identifier and asset identifier may be used to identify an individual asset meter and record a new meter reading.
  • Maximum Length: 240
    Comments about a meter reading. If defined, they will be displayed during retrieval of historical readings.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the meter reading has been disabled. If false, then the meter reading hasn't been disabled. This attribute doesn't have a default value. This attribute is read-only.
  • Unique identifying code of a meter template definition. Either the meter code or meter ID is required for a new reading. When the meter code is provided with the asset number, it's used to identify an individual asset meter and record a new meter reading. Alternatively, the meter identifier and asset identifier may be used to identify an individual asset meter and record a new meter reading.
  • Value that uniquely identifies the asset meter. The meter identifier along with the asset identifier is used to identify an individual asset meter and record a new meter reading. Alternatively, the meter code and asset number may be used to identify an individual asset meter and record a new meter reading.
  • Value that uniquely identifies a meter reading. This attribute is read-only. The value of this attribute is created when a meter reading is created for an asset meter.
  • Abbreviation that uniquely identifies whether the meter reading is created for an asset or for a contract line. Valid values are ORA_ASSET or ORA_CONTRACT_LINE. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.
  • Net change between the new and last meter reading in history. This attribute is read-only. The value of this attribute is created when a meter reading is created for an asset meter and is displayed during retrieval of historical readings.
  • Title: Reading Date-Time
    Date and time when the meter reading was taken. It must be less than or equal to the system date and time, greater than the last reading date and time, and is validated against the asset meter active start and end dates.
  • Maximum Length: 30
    Code that identifies the reading type of a meter reading. Valid values include ORA_ABSOLUTE, ORA_CHANGE, or ORA_RESET. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.
  • Value of a meter reading. For continuous absolute meters, the reading value must be less than, equal to, or greater than the last reading in history. For continuous change meters, the reading value must be greater than or equal to zero. If the meter template has a reading minimum, maximum, or rollover maximum defined, then the reading value must also pass these validations during creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the meter reading resulted in a reset of the meter. If false, then the meter reading did not result in a reset of the meter. The default value is false. This attribute is read-only. When creating the reading, if the reading type code is ORA_RESET, then this attribute will be automatically set to true.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the meter reading resulted in a rollover of the meter. If false, then the meter reading didn't result in a rollover of the meter. The default value is false. For continuous absolute ascending meters, passing a value of true will relax the validations that the reading value must be less than, equal to, or greater than the last reading in history.
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : meterReadings-item-response
Type: object
Show Source
  • Unique identifier of an asset. Either the asset number or asset identifier is required for a new reading. When the asset identifier is provided with the meter identifier, it's used to identify an individual asset meter and record a new meter reading. Alternatively, the meter code and asset number may be used to identify an individual asset meter and record a new meter reading.
  • Unique number of an asset. Either the asset number or asset identifier is required for a new reading. When the asset number is provided with the meter code, it's used to identify an individual asset meter and record a new meter reading. Alternatively, the meter identifier and asset identifier may be used to identify an individual asset meter and record a new meter reading.
  • Maximum Length: 240
    Comments about a meter reading. If defined, they will be displayed during retrieval of historical readings.
  • Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the meter reading has been disabled. If false, then the meter reading hasn't been disabled. This attribute doesn't have a default value. This attribute is read-only.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the meter reading was created and an initial reading occurred. If false, then an initial reading didn't occur. This attribute doesn't have a default value. This attribute is read-only.
  • Links
  • Unique identifying code of a meter template definition. Either the meter code or meter ID is required for a new reading. When the meter code is provided with the asset number, it's used to identify an individual asset meter and record a new meter reading. Alternatively, the meter identifier and asset identifier may be used to identify an individual asset meter and record a new meter reading.
  • Title: Meter Definition ID
    Read Only: true
    Value that uniquely identifies a meter template. The value is saved during reading creation as additional reference to the meter code or id that is passed. This attribute is read-only.
  • Value that uniquely identifies the asset meter. The meter identifier along with the asset identifier is used to identify an individual asset meter and record a new meter reading. Alternatively, the meter code and asset number may be used to identify an individual asset meter and record a new meter reading.
  • Value that uniquely identifies a meter reading. This attribute is read-only. The value of this attribute is created when a meter reading is created for an asset meter.
  • Abbreviation that uniquely identifies whether the meter reading is created for an asset or for a contract line. Valid values are ORA_ASSET or ORA_CONTRACT_LINE. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.
  • Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the meter reading has been modified. If false, then the meter reading hasn't been modified. This attribute doesn't have a default value. This attribute is read-only.
  • Net change between the new and last meter reading in history. This attribute is read-only. The value of this attribute is created when a meter reading is created for an asset meter and is displayed during retrieval of historical readings.
  • Title: Reading Date-Time
    Date and time when the meter reading was taken. It must be less than or equal to the system date and time, greater than the last reading date and time, and is validated against the asset meter active start and end dates.
  • Maximum Length: 30
    Code that identifies the reading type of a meter reading. Valid values include ORA_ABSOLUTE, ORA_CHANGE, or ORA_RESET. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.
  • Value of a meter reading. For continuous absolute meters, the reading value must be less than, equal to, or greater than the last reading in history. For continuous change meters, the reading value must be greater than or equal to zero. If the meter template has a reading minimum, maximum, or rollover maximum defined, then the reading value must also pass these validations during creation.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the meter reading resulted in a reset of the meter. If false, then the meter reading did not result in a reset of the meter. The default value is false. This attribute is read-only. When creating the reading, if the reading type code is ORA_RESET, then this attribute will be automatically set to true.
  • Maximum Length: 1
    Contains one of the following values: true or false. If true, then the meter reading resulted in a rollover of the meter. If false, then the meter reading didn't result in a rollover of the meter. The default value is false. For continuous absolute ascending meters, passing a value of true will relax the validations that the reading value must be less than, equal to, or greater than the last reading in history.
Back to Top

Examples

This example describes how to create one meter reading.

Example cURL Command

Use this cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
servername/fscmRestApi/resources/version/meterReadings"

Example 1 Request Body

The following example includes the contents of the request body for an asset meter in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
"AssetNumber": "F0554-02",
"MeterCode": "0554 HOURS",
"ReadingDate": "2018-03-14T16:27:00-07:00",
"ReadingTypeCode": "ORA_ABSOLUTE",
"MeterUsageCode": "ORA_ASSET",
"ReadingValue": 1108.12,
"Comments": "24ndsept Reading-108.12"
}

Example 1 Response Body

This example includes the contents of the response body in JSON format:

{
    "MeterReadingId": 300100141425958,
    "ReadingValue": 1108.12,
    "ReadingDate": "2018-03-14T23:27:00+00:00",
    "ReadingTypeCode": "ORA_ABSOLUTE",
    "NetValue": 1108.12,
    "Comments": "24ndsept Reading-108.12",
    "RolloverFlag": false,
    "ResetFlag": false,
    "ModifiedFlag": null,
    "InitialFlag": null,
    "DisabledFlag": null,
    "MeterDefinitionId": null,
    "MeterCode": null,
    "MeterId": 300100141395129,
    "MeterUsageCode": "ORA_ASSET",
    "AssetNumber": null,
    "AssetId": null
}

Example 2 Request Body

This example includes the contents of the request body for an asset meter in JSON format to create one meter reading according to the asset identifier and meter identifier. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
"AssetId": 300100117993592,
"MeterId": "300100141395129",
"ReadingDate": "2018-03-14T16:30:00-07:00",
"ReadingTypeCode": "ORA_ABSOLUTE",
"MeterUsageCode": "ORA_ASSET",
"ReadingValue": 1208.12,
"Comments": "24ndsept Reading-108.12"
}

Example 2 Response Body

This example includes the contents of the response body in JSON format:

{
    "MeterReadingId": 300100141428011,
    "ReadingValue": 1208.12,
    "ReadingDate": "2018-03-14T23:30:00+00:00",
    "ReadingTypeCode": "ORA_ABSOLUTE",
    "NetValue": 1208.12,
    "Comments": "24ndsept Reading-108.12",
    "RolloverFlag": false,
    "ResetFlag": false,
    "ModifiedFlag": null,
    "InitialFlag": null,
    "DisabledFlag": null,
    "MeterDefinitionId": null,
    "MeterCode": null,
    "MeterId": 300100141395129,
    "MeterUsageCode": "ORA_ASSET",
    "AssetNumber": null,
    "AssetId": null
}

Example 3 Request Body

This example includes the contents of the request body for a subscription meter in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it creates.

{
	"MeterId": 789789898,
	"ReadingDate": "2020-11-02",
	"ReadingTypeCode": "ORA_ABSOLUTE",
	"MeterUsageCode": "ORA_CONTRACT_LINE",
	"ReadingValue": 20,
	"Comments": null
}

Example 3 Response Body

This example includes the contents of the response body in JSON format:

{
	"MeterReadingId": 123456789,
	"ReadingValue": 20,
	"ReadingDate": "2020-11-02T00:00:00+00:00",
	"ReadingTypeCode": "ORA_ABSOLUTE",
	"NetValue": 1015,
	"Comments": null,
	"RolloverFlag": false,
	"ResetFlag": false,
	"ModifiedFlag": null,
	"InitialFlag": null,
	"DisabledFlag": null,
	"MeterDefinitionId": null,
	"MeterCode": null,
	"MeterId": 789789898,
	"MeterUsageCode": "ORA_CONTRACT_LINE",
	"AssetNumber": null,
	"AssetId": null
}

Example 4 Request Body

This example includes the contents of the request body for a subscription meter in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record to reset a meter. You replace the Reading Type Code with the value ORA_RESET and there is no need to pass a reading value as the reset value defined in the Meter Template will be used.

{
	"AssetNumber": "ALM_WO_METER_1",
	"MeterCode": "METER_TEMP_CODE_ABS_ASC_1",
	"ReadingDate": "2021-02-05T12:00:00+00:00",
	"ReadingTypeCode": "ORA_RESET",
	"MeterUsageCode": "ORA_ASSET",
	"Comments": null
}

Example 4 Response Body

This example includes the contents of the response body in JSON format:

{
   "MeterReadingId": 300100544973893,
   "ReadingValue": 0,
   "ReadingDate": "2021-02-05T12:00:00+00:00",
   "ReadingTypeCode": "ORA_RESET",
   "NetValue": 17,
   "Comments": null,
   "RolloverFlag": false,
   "ResetFlag": true,
   "ModifiedFlag": null,
   "InitialFlag": null,
   "DisabledFlag": false,
   "MeterDefinitionId": null,
   "MeterCode": null,
   "MeterId": 300100544697266,
   "MeterUsageCode": "ORA_ASSET",
   "AssetNumber": null,
   "AssetId": null
}
Back to Top