Create templates

post

/fscmRestApi/resources/11.13.18.05/meterTemplates

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.
  • Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: End Date
    Date when a meter template definition can no longer be associated to an asset. It is also used as the default active end date for the associated meters created for an asset. The date must be equal to or greater than the system date, greater than the active start date, and can be updated only for the meter template definition.
  • Title: Start Date
    Date when a meter template definition can be associated to an asset. It is also used as the default active start date for the associated meters created for an asset. The date must be equal to or greater than the system date, less than the active end date, and can be updated only for the meter template definition.
  • Title: Allow meter to be used in generating a maintenance program forecast
    Maximum Length: 1
    Default Value: false
    Determines whether you can use the meter for maintenance.
  • Title: Estimated Daily Utilization Rate
    Base utilization rate for each day. The application uses this attribute only if it does not calculate the daily utilization rate for the meter.
  • Title: Initial Reading
    Value of the initial reading in the meter template definition. It is used to default the initial reading for the associated meters created for an asset. The value can be updated only for the meter template definition.
  • Applicabilities
    Title: Applicabilities
    The Applicabilities resource allows you to apply items to a meter.
  • Title: Meter Code
    Maximum Length: 30
    Abbreviation that uniquely identifies a meter template definition. The code must be an alphanumeric value that includes uppercase alphabets. This value is referenced by the associated meters created for an asset. The code cannot be updated after creation.
  • Title: Meter Definition ID
    Value that uniquely identifies a meter template definition. It is a value that the application generates when it creates a meter template definition. This value is referenced during retrieval and update of a meter template definition. This value cannot be updated after creation.
  • Title: Meter Description
    Maximum Length: 240
    Description of the meter template definition. This value is displayed in the contextual action region for the associated meters created for an asset. The description cannot be updated after creation.
  • Title: Meter Name
    Maximum Length: 120
    Name of the meter template definition. The combination of name and code provides a unique identification of a meter template definition in user interfaces. This value is referenced by the associated meters created for an asset. The name cannot be updated after creation.
  • Title: Meters Created
    Maximum Length: 255
    Default Value: false
    Indicates if the meter template has been used to create one or more meters for an asset.
  • Title: Meter Type Code
    Maximum Length: 30
    Type of meter in the meter template definition. This value is referenced by the associated meters created for an asset. It identifies whether the meter is a continuous (for example, an odometer) or gauge (for example a thermometer) type. A list of accepted values is defined in the lookup ORA_CSE_METER_TYPE_CODE. The meter type cannot be updated in the list of values or after creation in the meter template definition.
  • Title: Reading Direction
    Maximum Length: 30
    Direction of a meter in the meter template definition. This value is referenced by the associated meters created for an asset. Depending on the meter type, it identifies whether the meter direction is ascending, descending, or bidirectional. A list of accepted values is defined in the lookup ORA_CSE_DIRECTION. The direction cannot be updated in the list of values or after creation in the meter template definition.
  • Title: Reading Maximum Value
    Value of the maximum meter reading in the meter template definition. It is referenced by the associated meters created for an asset. It can be defined only for a gauge absolute or a continuous change meter, as it is used to validate new readings recorded in the meter reading history. The value must be greater than zero and can be updated for the meter template definition after creation.
  • Title: Reading Minimum Value
    Value of the minimum meter reading in the meter template definition. It is referenced by the associated meters created for an asset. It can be defined only for a gauge absolute or a continuous change meter, as it is used to validate new readings recorded in the meter reading history. The value must be greater than zero and can be updated for the meter template definition after creation. If the meter template definition allows a rollover, then the value must be less than the rollover maximum value.
  • Title: Reading Type Code
    Maximum Length: 30
    Type of reading of a meter in the meter template definition. This value is referenced by the associated meters created for an asset. Depending on the meter type, it identifies whether the meter reading is recorded as an absolute value or a change (delta) value between the last and current value. A list of accepted values is defined in the lookup ORA_CSE_READING_TYPE_CODE. The reading type cannot be updated in the list of values or after creation in the meter template definition.
  • Title: Record Meters at Work Order Completion
    Maximum Length: 30
    Default Value: ORA_DO_NOT_ALLOW
    Abbreviation that identifies whether the application requires the meter recording while completing the work order.
  • Title: Reset allowed
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the asset meter is allowed to be reset when recording a new reading in the meter reading history. If false, then the asset meter is not allowed to be reset when recording a new reading in the meter reading history. The default value is false. It is referenced by the associated meters created for an asset. It cannot be defined for a gauge meter, and if set to true, then the reset value must also be defined. The flag can be updated after initial creation for the meter template definition.
  • Title: Reset Value
    Value of the reading that will be used for a reset event while recording the meter reading history. It is referenced by the associated meters created for an asset. The value must be greater than zero and should be equal to the lowest allowable reading value on a physical meter for an asset.
  • Title: Rollover allowed
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the asset meter is allowed to rollover when recording a new reading in the meter reading history. If false, then the asset meter is not allowed to rollover when recording a new reading in the meter reading history. The default value is false. It is referenced by the associated meters created for an asset. It can defined only for a continuous absolute or change ascending meter that may reach a maximum value before rolling over to a reset value and continuing recording. If set to true, then the rollover maximum and reset values must also be defined. The flag can be updated after initial creation for the meter template definition.
  • Title: Rollover Maximum Value
    Maximum value that will be used in the validations of a rollover event while recording meter reading history. It is referenced by the associated meters created for an asset. The value must be greater than zero and should equal the maximum allowable reading value on a physical meter for an asset, before the meter rolls over to a reset value and continues recording. The value can be updated after initial creation for the meter template definition.
  • Title: Rollover Minimum Value
    Minimum value that will be used in the validations of a rollover event while recording meter reading history. It is referenced by the associated meters created for an asset. the value should equal the minimum allowable reading value on a physical meter for an asset, after the meter rolls over to a reset value and continues recording. The value can be updated after initial creation for the meter template definition.
  • Title: Status
    Maximum Length: 255
    Value that identifies if the meter is ready or expired.
  • Title: Meter UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure of the meter template definition. This value is referenced by the associated meters created for an asset. It provides a context for the defining, recording, and viewing the meter reading history. A list of accepted values is defined in the lookup ORA_CSE_UOM_CODE. The unit of measure cannot be updated after creation in the meter template definition.
  • Title: Number of Readings to Calculate an Average Daily Utilization Rate
    Number of readings to consider when calculating the utilization rate.
Nested Schema : Applicabilities
Type: array
Title: Applicabilities
The Applicabilities resource allows you to apply items to a meter.
Show Source
Nested Schema : schema
Type: object
Show Source
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 : meterTemplates-item-response
Type: object
Show Source
  • Title: End Date
    Date when a meter template definition can no longer be associated to an asset. It is also used as the default active end date for the associated meters created for an asset. The date must be equal to or greater than the system date, greater than the active start date, and can be updated only for the meter template definition.
  • Title: Start Date
    Date when a meter template definition can be associated to an asset. It is also used as the default active start date for the associated meters created for an asset. The date must be equal to or greater than the system date, less than the active end date, and can be updated only for the meter template definition.
  • Title: Allow meter to be used in generating a maintenance program forecast
    Maximum Length: 1
    Default Value: false
    Determines whether you can use the meter for maintenance.
  • Title: Estimated Daily Utilization Rate
    Base utilization rate for each day. The application uses this attribute only if it does not calculate the daily utilization rate for the meter.
  • Title: Initial Reading
    Value of the initial reading in the meter template definition. It is used to default the initial reading for the associated meters created for an asset. The value can be updated only for the meter template definition.
  • Links
  • Applicabilities
    Title: Applicabilities
    The Applicabilities resource allows you to apply items to a meter.
  • Title: Meter Code
    Maximum Length: 30
    Abbreviation that uniquely identifies a meter template definition. The code must be an alphanumeric value that includes uppercase alphabets. This value is referenced by the associated meters created for an asset. The code cannot be updated after creation.
  • Title: Meter Definition ID
    Value that uniquely identifies a meter template definition. It is a value that the application generates when it creates a meter template definition. This value is referenced during retrieval and update of a meter template definition. This value cannot be updated after creation.
  • Title: Meter Description
    Maximum Length: 240
    Description of the meter template definition. This value is displayed in the contextual action region for the associated meters created for an asset. The description cannot be updated after creation.
  • Title: Meter Name
    Maximum Length: 120
    Name of the meter template definition. The combination of name and code provides a unique identification of a meter template definition in user interfaces. This value is referenced by the associated meters created for an asset. The name cannot be updated after creation.
  • Title: Meters Created
    Maximum Length: 255
    Default Value: false
    Indicates if the meter template has been used to create one or more meters for an asset.
  • Title: Meter Type
    Read Only: true
    Maximum Length: 80
    Descriptive meaning of the meter type code for the meter template definition that is returned after creation or retrieval. A list of accepted values is defined in the lookup ORA_CSE_METER_TYPE_CODE.
  • Title: Meter Type Code
    Maximum Length: 30
    Type of meter in the meter template definition. This value is referenced by the associated meters created for an asset. It identifies whether the meter is a continuous (for example, an odometer) or gauge (for example a thermometer) type. A list of accepted values is defined in the lookup ORA_CSE_METER_TYPE_CODE. The meter type cannot be updated in the list of values or after creation in the meter template definition.
  • Title: Reading Direction
    Maximum Length: 30
    Direction of a meter in the meter template definition. This value is referenced by the associated meters created for an asset. Depending on the meter type, it identifies whether the meter direction is ascending, descending, or bidirectional. A list of accepted values is defined in the lookup ORA_CSE_DIRECTION. The direction cannot be updated in the list of values or after creation in the meter template definition.
  • Title: Reading Direction Meaning
    Read Only: true
    Maximum Length: 80
    Descriptive meaning of the reading type code for the meter template definition that is returned after creation or retrieval. The meaning is from the seeded lookup code definition. A list of accepted values is defined in the lookup ORA_CSE_DIRECTION.
  • Title: Reading Maximum Value
    Value of the maximum meter reading in the meter template definition. It is referenced by the associated meters created for an asset. It can be defined only for a gauge absolute or a continuous change meter, as it is used to validate new readings recorded in the meter reading history. The value must be greater than zero and can be updated for the meter template definition after creation.
  • Title: Reading Minimum Value
    Value of the minimum meter reading in the meter template definition. It is referenced by the associated meters created for an asset. It can be defined only for a gauge absolute or a continuous change meter, as it is used to validate new readings recorded in the meter reading history. The value must be greater than zero and can be updated for the meter template definition after creation. If the meter template definition allows a rollover, then the value must be less than the rollover maximum value.
  • Title: Reading Type
    Read Only: true
    Maximum Length: 80
    Descriptive reading type of the reading type code for the meter template definition that is returned after creation or retrieval. The meaning is from the seeded lookup code definition. A list of accepted values is defined in the lookup ORA_CSE_READING_TYPE_CODE.
  • Title: Reading Type Code
    Maximum Length: 30
    Type of reading of a meter in the meter template definition. This value is referenced by the associated meters created for an asset. Depending on the meter type, it identifies whether the meter reading is recorded as an absolute value or a change (delta) value between the last and current value. A list of accepted values is defined in the lookup ORA_CSE_READING_TYPE_CODE. The reading type cannot be updated in the list of values or after creation in the meter template definition.
  • Title: Record Meters at Work Order Completion
    Maximum Length: 30
    Default Value: ORA_DO_NOT_ALLOW
    Abbreviation that identifies whether the application requires the meter recording while completing the work order.
  • Title: Record Meters at Work Order Completion
    Read Only: true
    Maximum Length: 80
    Meaning that identifies if the application requires the meter recording while completing the work order.
  • Title: Reset allowed
    Read Only: true
    Maximum Length: 80
    Meaning of the reset allowed flag that is returned after creation or retrieval. If the flag is set to True, the value returned is Yes. If the flag is set to False, the value returned is No.
  • Title: Reset allowed
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the asset meter is allowed to be reset when recording a new reading in the meter reading history. If false, then the asset meter is not allowed to be reset when recording a new reading in the meter reading history. The default value is false. It is referenced by the associated meters created for an asset. It cannot be defined for a gauge meter, and if set to true, then the reset value must also be defined. The flag can be updated after initial creation for the meter template definition.
  • Title: Reset Value
    Value of the reading that will be used for a reset event while recording the meter reading history. It is referenced by the associated meters created for an asset. The value must be greater than zero and should be equal to the lowest allowable reading value on a physical meter for an asset.
  • Title: Rollover allowed
    Read Only: true
    Maximum Length: 80
    Meaning of the rollover allowed flag that is returned after creation or retrieval. If the flag is set to True, the value returned is Yes. If the flag is set to False, the value returned is No.
  • Title: Rollover allowed
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the asset meter is allowed to rollover when recording a new reading in the meter reading history. If false, then the asset meter is not allowed to rollover when recording a new reading in the meter reading history. The default value is false. It is referenced by the associated meters created for an asset. It can defined only for a continuous absolute or change ascending meter that may reach a maximum value before rolling over to a reset value and continuing recording. If set to true, then the rollover maximum and reset values must also be defined. The flag can be updated after initial creation for the meter template definition.
  • Title: Rollover Maximum Value
    Maximum value that will be used in the validations of a rollover event while recording meter reading history. It is referenced by the associated meters created for an asset. The value must be greater than zero and should equal the maximum allowable reading value on a physical meter for an asset, before the meter rolls over to a reset value and continues recording. The value can be updated after initial creation for the meter template definition.
  • Title: Rollover Minimum Value
    Minimum value that will be used in the validations of a rollover event while recording meter reading history. It is referenced by the associated meters created for an asset. the value should equal the minimum allowable reading value on a physical meter for an asset, after the meter rolls over to a reset value and continues recording. The value can be updated after initial creation for the meter template definition.
  • Title: Status
    Maximum Length: 255
    Value that identifies if the meter is ready or expired.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 25
    Associated descriptive name of the unit of measure code for the meter template definition that is returned after creation or retrieval.
  • Title: Meter UOM
    Maximum Length: 3
    Abbreviation that identifies the unit of measure of the meter template definition. This value is referenced by the associated meters created for an asset. It provides a context for the defining, recording, and viewing the meter reading history. A list of accepted values is defined in the lookup ORA_CSE_UOM_CODE. The unit of measure cannot be updated after creation in the meter template definition.
  • Title: Number of Readings to Calculate an Average Daily Utilization Rate
    Number of readings to consider when calculating the utilization rate.
Nested Schema : Applicabilities
Type: array
Title: Applicabilities
The Applicabilities resource allows you to apply items to a meter.
Show Source
Nested Schema : meterTemplates-MeterApplicability-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to create one template.

Example cURL Command

Use the following 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/meterTemplates"

Example Request Body

The following example includes the contents of the request body in JSON format to create meter template without meter applicability. 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.

{
	"MeterCode": "NC_M_TEMPL-DEMO-1",
	"MeterName": "NC_M_TEMPL-DEMO-1",
	"UOMCode": "EA",
	"MeterTypeCode": "ORA_CONTINUOUS",
	"ReadingTypeCode": "ORA_CHANGE",
	"ReadingDirection": "ORA_ASCENDING",
	"InitialReadingValue": 0,
	"ResetAllowedFlag": "Y",
	"ResetValue":0,
	"RolloverAllowedFlag": "Y",
	"RolloverMaximumValue":100,
	"RolloverResetValue":0,
	"ActiveStartDate": "2017-09-03T00:00:00-07:00",
	"ActiveEndDate": "2018-08-27T00:00:00-07:00"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "MeterDefinitionId": 300100126598933,
    "MeterCode": "NC_M_TEMPL-DEMO-1",
    "MeterName": "NC_M_TEMPL-DEMO-1",
    "MeterDescription": null,
    "UOMCode": "EA",
    "MeterTypeCode": "ORA_CONTINUOUS",
    "ReadingTypeCode": "ORA_CHANGE",
    "ReadingDirection": "ORA_ASCENDING",
    "ActiveStartDate": "2017-09-03T07:00:00+00:00",
    "ActiveEndDate": "2018-08-27T07:00:00+00:00",
    "InitialReadingValue": 0,
    "ReadingMinimumValue": null,
    "ReadingMaximumValue": null,
    "ResetAllowedFlag": true,
    "ResetValue": 0,
    "RolloverAllowedFlag": true,
    "RolloverMaximumValue": 100,
    "RolloverResetValue": 0,
    "RolloverAllowed": "New Entries Only",
    "ResetAllowed": "New Entries Only",
    "UnitOfMeasure": "EA",
    "MeterType": "Continuous",
    "ReadingDirectionMeaning": "Ascending",
    "ReadingType": "Change Orders",
}

Example Request Body

The following example includes the contents of the request body in JSON format to create multiple meter templates without meter applicability. 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.

{
 "MeterCode": "NC_M_TEMPL-DEMO-1",
 "MeterName": "NC_M_TEMPL-DEMO-1",
 "UOMCode": "EA",
 "MeterTypeCode": "ORA_CONTINUOUS",
 "ReadingTypeCode": "ORA_CHANGE",
 "ReadingDirection": "ORA_ASCENDING",
 "InitialReadingValue": 0,
 "ResetAllowedFlag": "Y",
 "ResetValue":0,
 "RolloverAllowedFlag": "Y",
 "RolloverMaximumValue":100,
 "RolloverResetValue":0,
 "ActiveStartDate": "2017-09-03T00:00:00-07:00",
 "ActiveEndDate": "2018-08-27T00:00:00-07:00"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "MeterDefinitionId": 300100126598933,
    "MeterCode": "NC_M_TEMPL-DEMO-1",
    "MeterName": "NC_M_TEMPL-DEMO-1",
    "MeterDescription": null,
    "UOMCode": "EA",
    "MeterTypeCode": "ORA_CONTINUOUS",
    "ReadingTypeCode": "ORA_CHANGE",
    "ReadingDirection": "ORA_ASCENDING",
    "ActiveStartDate": "2017-09-03T07:00:00+00:00",
    "ActiveEndDate": "2018-08-27T07:00:00+00:00",
    "InitialReadingValue": 0,
    "ReadingMinimumValue": null,
    "ReadingMaximumValue": null,
    "ResetAllowedFlag": true,
    "ResetValue": 0,
    "RolloverAllowedFlag": true,
    "RolloverMaximumValue": 100,
    "RolloverResetValue": 0,
    "RolloverAllowed": "New Entries Only",
    "ResetAllowed": "New Entries Only",
    "UnitOfMeasure": "EA",
    "MeterType": "Continuous",
    "ReadingDirectionMeaning": "Ascending",
    "ReadingType": "Change Orders",
}

Example Request Body

The following example includes the contents of the request body in JSON format to create one meter template with meter applicability. 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.

{
 "MeterCode": "NC-MTR-TMPL-DEMO-12",
 "MeterName": "NC-MTR-TMPL-DEMO-12",
 "UOMCode": "EA",
 "MeterTypeCode": "ORA_CONTINUOUS",
 "ReadingTypeCode": "ORA_CHANGE",
 "ReadingDirection": "ORA_ASCENDING",
 "InitialReadingValue": 0,
 "ResetAllowedFlag": "Y",
 "ResetValue":0,
 "RolloverAllowedFlag": "N",
 "ActiveStartDate": "2017-09-03T00:00:00-07:00",
 "ActiveEndDate": "2018-08-27T00:00:00-07:00",
 "MeterApplicability": [{
   "MasterOrganizationId": 204,
   "ActiveStartDate": "2017-09-03T00:00:00-07:00",
   "ActiveEndDate": "2018-08-27T00:00:00-07:00",
   "ItemNumber": "alm-srl-001"
  }]
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "MeterDefinitionId": 300100126599039,
    "MeterCode": "NC-MTR-TMPL-DEMO-12",
    "MeterName": "NC-MTR-TMPL-DEMO-12",
    "MeterDescription": null,
    "UOMCode": "EA",
    "MeterTypeCode": "ORA_CONTINUOUS",
    "ReadingTypeCode": "ORA_CHANGE",
    "ReadingDirection": "ORA_ASCENDING",
    "ActiveStartDate": "2017-09-03T07:00:00+00:00",
    "ActiveEndDate": "2018-08-27T07:00:00+00:00",
    "InitialReadingValue": 0,
    "ReadingMinimumValue": null,
    "ReadingMaximumValue": null,
    "ResetAllowedFlag": true,
    "ResetValue": 0,
    "RolloverAllowedFlag": false,
    "RolloverMaximumValue": null,
    "RolloverResetValue": null,
    "RolloverAllowed": "NULL",
    "ResetAllowed": "New Entries Only",
    "UnitOfMeasure": "EA",
    "MeterType": "Continuous",
    "ReadingDirectionMeaning": "Ascending",
    "ReadingType": "Change Orders",
    "MeterApplicability": [
        {
            "ActiveEndDate": "2018-08-27T07:00:00+00:00",
            "ActiveStartDate": "2017-09-03T07:00:00+00:00",
            "ApplicabilityId": 300100126599041,
            "MeterDefinitionId": 300100126599039,
            "MasterOrganizationId": 204,
            "ObjectVersionNumber": 1,
            "ItemNumber": null,
            "MasterOrganizationCode": null,
            "ItemId": null
}
]
}
Back to Top