Get all templates
get
/fscmRestApi/resources/11.13.18.05/meterTemplates
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- MeterDefnByMeterDefnId: Find the meter according to the value that identifies the meter.
Finder Variables:- MeterDefinitionId; integer; Value that uniquely identifies the meter.
- PrimaryKey: Find the meter according to the value that identifies the meter as the primary key.
Finder Variables:- MeterDefinitionId; integer; Value that uniquely identifies the meter.
- MeterDefnByMeterDefnId: Find the meter according to the value that identifies the meter.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActiveEndDate; string; 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.
- ActiveStartDate; string; 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.
- AllowInMaintProgramFlag; boolean; Determines whether you can use the meter for maintenance.
- DailyUtilizationRate; number; Base utilization rate for each day. The application uses this attribute only if it does not calculate the daily utilization rate for the meter.
- InitialReadingValue; number; 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.
- MeterCode; string; 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.
- MeterDefinitionId; integer; 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.
- MeterDescription; string; 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.
- MeterName; string; 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.
- MeterType; string; 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.
- MeterTypeCode; string; 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.
- MetersCreatedFlag; boolean; Indicates if the meter template has been used to create one or more meters for an asset.
- ReadingDirection; string; 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.
- ReadingDirectionMeaning; string; 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.
- ReadingMaximumValue; number; 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.
- ReadingMinimumValue; number; 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.
- ReadingType; string; 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.
- ReadingTypeCode; string; 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.
- RecordAtWoComplCode; string; Abbreviation that identifies whether the application requires the meter recording while completing the work order.
- RecordAtWoCompletion; string; Meaning that identifies if the application requires the meter recording while completing the work order.
- ResetAllowed; string; 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.
- ResetAllowedFlag; boolean; 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.
- ResetValue; number; 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.
- RolloverAllowed; string; 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.
- RolloverAllowedFlag; boolean; 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.
- RolloverMaximumValue; number; 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.
- RolloverResetValue; number; 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.
- Status; string; Value that identifies if the meter is ready or expired.
- UOMCode; string; 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.
- UnitOfMeasure; string; Associated descriptive name of the unit of measure code for the meter template definition that is returned after creation or retrieval.
- UtilizationRateComputedAt; integer; Number of readings to consider when calculating the utilization rate.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
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".
-
REST-Framework-Version:
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.
Root Schema : meterTemplates
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : meterTemplates-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
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. -
ActiveStartDate: string
(date-time)
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. -
AllowInMaintProgramFlag: boolean
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. -
DailyUtilizationRate: number
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. -
InitialReadingValue: number
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: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterApplicability: array
Applicabilities
Title:
Applicabilities
The Applicabilities resource allows you to apply items to a meter. -
MeterCode: string
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. -
MeterDefinitionId: integer
(int64)
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. -
MeterDescription: string
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. -
MeterName: string
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. -
MetersCreatedFlag: boolean
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. -
MeterType: string
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. -
MeterTypeCode: string
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. -
ReadingDirection: string
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. -
ReadingDirectionMeaning: string
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. -
ReadingMaximumValue: number
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. -
ReadingMinimumValue: number
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. -
ReadingType: string
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. -
ReadingTypeCode: string
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. -
RecordAtWoComplCode: string
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. -
RecordAtWoCompletion: string
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. -
ResetAllowed: string
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. -
ResetAllowedFlag: boolean
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. -
ResetValue: number
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. -
RolloverAllowed: string
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. -
RolloverAllowedFlag: boolean
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. -
RolloverMaximumValue: number
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. -
RolloverResetValue: number
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. -
Status: string
Title:
Status
Maximum Length:255
Value that identifies if the meter is ready or expired. -
UnitOfMeasure: string
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. -
UOMCode: string
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. -
UtilizationRateComputedAt: integer
Title:
Number of Readings to Calculate an Average Daily Utilization Rate
Number of readings to consider when calculating the utilization rate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Applicabilities
Type:
array
Title:
Applicabilities
The Applicabilities resource allows you to apply items to a meter.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : meterTemplates-MeterApplicability-item-response
Type:
Show Source
object
-
ActiveEndDate: string
(date-time)
Title:
End Date
Date when to stop using the item to create a meter for a new asset. -
ActiveStartDate: string
(date-time)
Title:
Start Date
Date when to start using the item to create a meter for a new asset. -
ApplicabilityId: integer
(int64)
Title:
Applicability ID
Value that uniquely identifies the meter applicability. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description of the item that the meter measures. -
ItemId: integer
(int64)
Value that uniquely identifies the item that the meter measures.
-
ItemNumber: string
Title:
Item Number
Maximum Length:300
Number that identifies the item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MasterOrganizationCode: string
Title:
Master Organization
Maximum Length:255
Abbreviation that identifies the organization where the work order creates the item. -
MasterOrganizationId: integer
(int64)
Title:
Master Organization
Value that uniquely identifies the organization where the work order creates the item. -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition ID
Value that uniquely identifies the meter. -
ObjectVersionNumber: integer
(int32)
Number that identifies the object version.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- associateMeterToAsset
-
This is primarily to support the export feature from meter templates Ui,where user performs a association of meter template to assets. This method will collect meter definition id and It will schedule the ESS job for the association of the meter template to assets.
Examples
This example describes how to get all meter definitions.
Example cURL Command
Use the following cURL command to submit a request on the REST resource:
curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates"
Example Response Body
The following shows an example of the response body in JSON format.
{ "MeterDefinitionId": 300100125878002, "MeterCode": "ODOMETER", "MeterName": "Odometer", "MeterDescription": "Odometer", "UOMCode": "ML", "MeterTypeCode": "ORA_CONTINUOUS", "ReadingTypeCode": "ORA_ABSOLUTE", "ReadingDirection": "ORA_ASCENDING", "ActiveStartDate": "2018-03-05T00:00:00+00:00", "ActiveEndDate": null, "InitialReadingValue": 0, "ReadingMinimumValue": null, "ReadingMaximumValue": null, "ResetAllowedFlag": false, "ResetValue": null, "RolloverAllowedFlag": false, "RolloverMaximumValue": null, "RolloverResetValue": null, "RolloverAllowed": "No", "ResetAllowed": "No", "UnitOfMeasure": "Miles", "MeterType": "Continuous", "ReadingDirectionMeaning": "Ascending", "ReadingType": "Absolute", }