Jump to

• Request
• Response

Get all utilization meters

get

/fscmRestApi/resources/11.13.18.05/utilizationMeters

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:
  
  

  • MetersByAsset: Finds utilization meters according to provided asset and workorder identifiers.
    Finder Variables:
    • AssetId; integer; Value that uniquely identifies the asset.
    • ContextWorkOrderId; integer; Value that uniquely identifies the context of the work order identifier.
  • PrimaryKey: Finds the assets meter latest reading according to the asset identifier.
    Finder Variables:
    • MeterId; integer; Value that uniquely identifies the asset meter reading.
• 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 the application can no longer use the meter template for the asset. The application sets this value to the default active end date for the meter that it created for the asset. The date must be equal to or greater than the system date, and it must be greater than the value of the active start date.
  • ActiveStartDate; string; Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value of the active end date.
  • AllowInMaintProgramFlag; boolean; Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter cannot be used for scheduling a maintenance program. The default value is false.
  • AssetId; integer; Asset Identifier for meter reading. The attribute is read-only.
  • AssetNumber; string; Value that uniquely identifies the asset for the meter. This attribute is read-only.
  • CalculatedUtilizationRate; number; Value of the calculated utilization rate based on the number of active readings in history. This attribute is read-only.
  • CreatedBy; string; Date the utilization meter was created. The attribute is read-only.
  • CreationDate; string; User that created the utilization meter. The attribute is read-only.
  • DailyUtilizationRate; number; Expected average daily total of readings that are to be entered for a meter.
  • DisplayedReading; number; Value that's indicated on a meter. This value is the same as the Life-to-Date Reading value up until the point that a meter is reset or encounters a rollover event. For a change meter, this value is calculated by adding the current net change value to the previous displayed reading value. For an absolute meter, this value is always the same as the reading value. This attribute is read-only.
  • InitialReadingValue; number; Value of the initial reading from the meter definition. This attribute is read-only.
  • LastReadingComments; string; Comments of the last active meter reading in history. This attribute is read-only.
  • LastReadingDate; string; Date of the last active meter reading in history. This attribute is read-only.
  • LastReadingValue; number; Value of the last active meter reading in history. This attribute is read-only.
  • LastUpdateDate; string; User that updated the utilization meter. The attribute is read-only.
  • LastUpdatedBy; string; Date the utilization meter was last updated. The attribute is read-only.
  • LifeToDateReading; number; Value that represents the cumulative reading value for an asset meter, irrespective of reset or rollover events, over time. It's incremented by the recording new meter readings. This attribute is read-only.
  • MeterCode; string; Abbreviation that identifies the meter template. This value must use uppercase letters and it can be alphanumeric. Each meter that the application creates for the asset references this value.
  • MeterDefinitionId; integer; Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only.
  • MeterDescription; string; Description of the meter template. This attribute provides a brief user-defined text providing information on the template characteristics.
  • MeterId; integer; Value that uniquely identifies the asset meter. The application uses this value and the value that identifies the asset to identify the asset meter, and then record a new meter reading. As an alternative, the application can use the meter code and the asset number to identify the asset meter and record the new reading.
  • MeterName; string; Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of the meter name and meter code provide a unique value that identifies the meter template.
  • MeterObjectId; integer; Value that uniquely identifies the business object that the application creates for this meter. This value represents the asset identifier that the application gets from the asset that references the meter.
  • MeterType; string; Meaning of the type of meter in the meter template. This attribute is read-only.
  • MeterTypeCode; string; Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for meter code are continuous, similar to an odometer or a gauge similar to a thermometer. A list of accepted values is defined in the lookup type ORA_CSE_METER_TYPE_CODE.
  • MeterUsageCode; string; Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line. Valid values include ORA_ASSET or ORA_CONTRACT. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.
  • ProductName; string; Subscription product name, The attribute is read-only.
  • ProductNumber; string; Subscription product number, The attribute is read-only.
  • ReadingDirection; string; Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. This attribute specifies the direction to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. A list of accepted values is defined in the lookup type ORA_CSE_DIRECTION.
  • ReadingDirectionMeaning; string; Meaning of the reading direction in the meter template. This attribute is read-only.
  • ReadingType; string; Meaning of the reading type in the meter template. This attribute is read-only.
  • ReadingTypeCode; string; Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. This attribute specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.
  • RecordAtWoComplCode; string; Abbreviation that identifies the option that is used to control the meter reading entry at work order completion.
  • RecordAtWoComplMeaning; string; Meaning that identifies the option that is used to control the meter reading entry at work order completion. This attribute is read-only.
  • ResetAllowedFlag; boolean; Contains one of the following values: true or false. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then don't allow. If true, then you must define ResetValue. The default value is false. Each meter that the application creates for the asset references this value. You cannot define an indicator for a gauge meter.
  • ResetValue; number; Reset value for the meter in the meter template. The application uses this attribute as the reset value when it records the meter reading history. If you set ResetAllowedFlag to true, then you must specify a value for ResetValue. Each meter that the application creates for the asset references this attribute. This attribute must contain a value that is greater than zero, and that is equal to the lowest reading value that the physical meter allows for the asset.
  • RolloverAllowedFlag; boolean; Contains one of the following values: true or false. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then don't allow rollover. If true, then you must specify values for RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedFlag is false. RolloverAllowedFlag is required. Each meter that the application creates for the asset references RolloverAllowedFlag. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording. The default value is false.
  • RolloverMaximumValue; number; Maximum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If RolloverAllowedFlag is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value of RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.
  • RolloverResetValue; number; Minimum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value of RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.
  • SubscriptionProductId; integer; Value that uniquely identifies the subscription product. The attribute is read-only.
  • SubscriptionProductPuid; string; Value that identifies the subscription product. The attribute is read-only.
  • UOMCode; string; Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. This attribute provides a context that you can use to define, record, or view meter history. A list of accepted values is defined in the lookup type ORA_CSE_UOM_CODE.
  • UnitOfMeasure; string; Meaning of the unit of measure in the meter template. This attribute is read-only.
  • UtilizationRateComputedAt; number; Number of readings in history for which meter readings will be used to calculate a daily utilization rate.
  • WoReadingRecordedFlag; boolean; Value that identifies the recorded reading of the work order. The attribute is read-only.
  • WorkOrderId; integer; Unique identifier of the maintenance work order from which the meter reading was recorded. The attribute is read-only.
  • WorkOrderNumber; string; Name of the maintenance work order from which the meter reading was recorded. The attribute is read-only.
• 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: string
  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: string
  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 Top

Response

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.

Body ()

Root Schema : utilizationMeters

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/utilizationMeters-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object utilizationMeters-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/utilizationMeters-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : utilizationMeters-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  Title: End Date

  Read Only: true

  Date when the application can no longer use the meter template for the asset. The application sets this value to the default active end date for the meter that it created for the asset. The date must be equal to or greater than the system date, and it must be greater than the value of the active start date.
• ActiveStartDate: string (date-time)
  Title: Start Date

  Read Only: true

  Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value of the active end date.
• AllowInMaintProgramFlag: boolean
  Title: Allow meter to be used in generating a maintenance program forecast

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter cannot be used for scheduling a maintenance program. The default value is false.
• AssetId: integer (int64)
  Read Only: true

  Asset Identifier for meter reading. The attribute is read-only.
• AssetNumber: string
  Title: Asset

  Read Only: true

  Maximum Length: 80

  Value that uniquely identifies the asset for the meter. This attribute is read-only.
• CalculatedUtilizationRate: number
  Title: Calculated Utilization Rate per Day

  Read Only: true

  Value of the calculated utilization rate based on the number of active readings in history. This attribute is read-only.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Date the utilization meter was created. The attribute is read-only.
• CreationDate: string (date-time)
  Read Only: true

  User that created the utilization meter. The attribute is read-only.
• DailyUtilizationRate: number
  Title: Estimated Daily Utilization Rate

  Read Only: true

  Expected average daily total of readings that are to be entered for a meter.
• DisplayedReading: number
  Title: Displayed Reading

  Read Only: true

  Value that's indicated on a meter. This value is the same as the Life-to-Date Reading value up until the point that a meter is reset or encounters a rollover event. For a change meter, this value is calculated by adding the current net change value to the previous displayed reading value. For an absolute meter, this value is always the same as the reading value. This attribute is read-only.
• InitialReadingValue: number
  Title: Initial Reading

  Read Only: true

  Value of the initial reading from the meter definition. This attribute is read-only.
• LastReadingComments: string
  Title: Comments

  Read Only: true

  Maximum Length: 240

  Comments of the last active meter reading in history. This attribute is read-only.
• LastReadingDate: string (date-time)
  Title: Last Reading Date

  Read Only: true

  Date of the last active meter reading in history. This attribute is read-only.
• LastReadingValue: number
  Title: Last Reading Value

  Read Only: true

  Value of the last active meter reading in history. This attribute is read-only.
• LastUpdateDate: string (date-time)
  Read Only: true

  User that updated the utilization meter. The attribute is read-only.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Date the utilization meter was last updated. The attribute is read-only.
• LifeToDateReading: number
  Title: Net

  Read Only: true

  Value that represents the cumulative reading value for an asset meter, irrespective of reset or rollover events, over time. It's incremented by the recording new meter readings. This attribute is read-only.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterCode: string
  Title: Meter Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the meter template. This value must use uppercase letters and it can be alphanumeric. Each meter that the application creates for the asset references this value.
• MeterDefinitionId: integer (int64)
  Title: Meter Definition ID

  Read Only: true

  Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only.
• MeterDescription: string
  Title: Meter Description

  Read Only: true

  Maximum Length: 240

  Description of the meter template. This attribute provides a brief user-defined text providing information on the template characteristics.
• MeterId: integer
  Read Only: true

  Value that uniquely identifies the asset meter. The application uses this value and the value that identifies the asset to identify the asset meter, and then record a new meter reading. As an alternative, the application can use the meter code and the asset number to identify the asset meter and record the new reading.
• MeterName: string
  Title: Meter Name

  Read Only: true

  Maximum Length: 120

  Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of the meter name and meter code provide a unique value that identifies the meter template.
• MeterObjectId: integer (int64)
  Read Only: true

  Value that uniquely identifies the business object that the application creates for this meter. This value represents the asset identifier that the application gets from the asset that references the meter.
• MeterType: string
  Title: Meter Type

  Read Only: true

  Maximum Length: 80

  Meaning of the type of meter in the meter template. This attribute is read-only.
• MeterTypeCode: string
  Title: Meter Type Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for meter code are continuous, similar to an odometer or a gauge similar to a thermometer. A list of accepted values is defined in the lookup type ORA_CSE_METER_TYPE_CODE.
• MeterUsageCode: string
  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line. Valid values include ORA_ASSET or ORA_CONTRACT. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.
• ProductName: string
  Read Only: true

  Maximum Length: 300

  Subscription product name, The attribute is read-only.
• ProductNumber: string
  Read Only: true

  Maximum Length: 300

  Subscription product number, The attribute is read-only.
• ReadingDirection: string
  Title: Reading Direction

  Read Only: true

  Maximum Length: 30

  Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. This attribute specifies the direction to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. A list of accepted values is defined in the lookup type ORA_CSE_DIRECTION.
• ReadingDirectionMeaning: string
  Title: Reading Direction Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the reading direction in the meter template. This attribute is read-only.
• ReadingType: string
  Title: Reading Type

  Read Only: true

  Maximum Length: 80

  Meaning of the reading type in the meter template. This attribute is read-only.
• ReadingTypeCode: string
  Title: Reading Type Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. This attribute specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.
• RecordAtWoComplCode: string
  Title: Record Meters at Work Order Completion

  Read Only: true

  Maximum Length: 30

  Abbreviation that identifies the option that is used to control the meter reading entry at work order completion.
• RecordAtWoComplMeaning: string
  Title: Record Meters at Work Order Completion

  Read Only: true

  Maximum Length: 80

  Meaning that identifies the option that is used to control the meter reading entry at work order completion. This attribute is read-only.
• ResetAllowedFlag: boolean
  Title: Reset allowed

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then don't allow. If true, then you must define ResetValue. The default value is false. Each meter that the application creates for the asset references this value. You cannot define an indicator for a gauge meter.
• ResetValue: number
  Title: Reset Value

  Read Only: true

  Reset value for the meter in the meter template. The application uses this attribute as the reset value when it records the meter reading history. If you set ResetAllowedFlag to true, then you must specify a value for ResetValue. Each meter that the application creates for the asset references this attribute. This attribute must contain a value that is greater than zero, and that is equal to the lowest reading value that the physical meter allows for the asset.
• RolloverAllowedFlag: boolean
  Title: Rollover allowed

  Read Only: true

  Maximum Length: 1

  Contains one of the following values: true or false. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then don't allow rollover. If true, then you must specify values for RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedFlag is false. RolloverAllowedFlag is required. Each meter that the application creates for the asset references RolloverAllowedFlag. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording. The default value is false.
• RolloverMaximumValue: number
  Title: Rollover Maximum Value

  Read Only: true

  Maximum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If RolloverAllowedFlag is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value of RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.
• RolloverResetValue: number
  Title: Rollover Reset Value

  Read Only: true

  Minimum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value of RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.
• SubscriptionProductId: integer (int64)
  Read Only: true

  Value that uniquely identifies the subscription product. The attribute is read-only.
• SubscriptionProductPuid: string
  Read Only: true

  Maximum Length: 120

  Value that identifies the subscription product. The attribute is read-only.
• UnitOfMeasure: string
  Title: Meter UOM

  Read Only: true

  Maximum Length: 25

  Meaning of the unit of measure in the meter template. This attribute is read-only.
• UOMCode: string
  Title: UOM

  Read Only: true

  Maximum Length: 3

  Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. This attribute provides a context that you can use to define, record, or view meter history. A list of accepted values is defined in the lookup type ORA_CSE_UOM_CODE.
• UtilizationRateComputedAt: number
  Title: Number of Readings to Calculate an Average Daily Utilization Rate

  Read Only: true

  Number of readings in history for which meter readings will be used to calculate a daily utilization rate.
• WoReadingRecordedFlag: boolean
  Read Only: true

  Value that identifies the recorded reading of the work order. The attribute is read-only.
• WorkOrderId: integer (int64)
  Read Only: true

  Unique identifier of the maintenance work order from which the meter reading was recorded. The attribute is read-only.
• WorkOrderNumber: string
  Read Only: true

  Maximum Length: 120

  Name of the maintenance work order from which the meter reading was recorded. The attribute is read-only.

{
    "type":"object",
    "properties":{
        "RolloverAllowedFlag":{
            "title":"Rollover allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the application to rollover the asset meter in the meter template when it records a new reading in the meter reading history. If false, then don't allow rollover. If true, then you must specify values for RolloverMaximumValue and RolloverResetValue. The default value for RolloverAllowedFlag is false. RolloverAllowedFlag is required. Each meter that the application creates for the asset references RolloverAllowedFlag. You can allow rollover only for a continuous absolute or for a change ascending meter, and only for a meter that can reach a maximum value before it rolls over to a reset value, and then continue recording. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"User that created the utilization meter. The attribute is read-only.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastReadingValue":{
            "title":"Last Reading Value",
            "type":"number",
            "description":"Value of the last active meter reading in history. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductName":{
            "maxLength":300,
            "type":"string",
            "description":"Subscription product name, The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterType":{
            "title":"Meter Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the type of meter in the meter template. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterTypeCode":{
            "title":"Meter Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of meter in the meter template. Each meter that the application creates for the asset references this value. Values for meter code are continuous, similar to an odometer or a gauge similar to a thermometer. A list of accepted values is defined in the lookup type ORA_CSE_METER_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordAtWoComplMeaning":{
            "title":"Record Meters at Work Order Completion",
            "maxLength":80,
            "type":"string",
            "description":"Meaning that identifies the option that is used to control the meter reading entry at work order completion. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterCode":{
            "title":"Meter Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the meter template. This value must use uppercase letters and it can be alphanumeric. Each meter that the application creates for the asset references this value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset",
            "maxLength":80,
            "type":"string",
            "description":"Value that uniquely identifies the asset for the meter. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterId":{
            "type":"integer",
            "description":"Value that uniquely identifies the asset meter. The application uses this value and the value that identifies the asset to identify the asset meter, and then record a new meter reading. As an alternative, the application can use the meter code and the asset number to identify the asset meter and record the new reading.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterDescription":{
            "title":"Meter Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the meter template. This attribute provides a brief user-defined text providing information on the template characteristics.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter template. The application creates this value when it creates a meter template. This attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MeterObjectId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business object that the application creates for this meter. This value represents the asset identifier that the application gets from the asset that references the meter.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastReadingDate":{
            "title":"Last Reading Date",
            "type":"string",
            "description":"Date of the last active meter reading in history. This attribute is read-only.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingType":{
            "title":"Reading Type",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the reading type in the meter template. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterName":{
            "title":"Meter Name",
            "maxLength":120,
            "type":"string",
            "description":"Name of the meter template. Each meter that the application creates for the asset references this value. The combined values of the meter name and meter code provide a unique value that identifies the meter template.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UtilizationRateComputedAt":{
            "title":"Number of Readings to Calculate an Average Daily Utilization Rate",
            "type":"number",
            "description":"Number of readings in history for which meter readings will be used to calculate a daily utilization rate.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoReadingRecordedFlag":{
            "type":"boolean",
            "description":"Value that identifies the recorded reading of the work order. The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResetValue":{
            "title":"Reset Value",
            "type":"number",
            "description":"Reset value for the meter in the meter template. The application uses this attribute as the reset value when it records the meter reading history. If you set ResetAllowedFlag to true, then you must specify a value for ResetValue. Each meter that the application creates for the asset references this attribute. This attribute must contain a value that is greater than zero, and that is equal to the lowest reading value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductId":{
            "type":"integer",
            "description":"Value that uniquely identifies the subscription product. The attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when the application can no longer use the meter template for the asset. The application sets this value to the default active end date for the meter that it created for the asset. The date must be equal to or greater than the system date, and it must be greater than the value of the active start date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"UOM",
            "maxLength":3,
            "type":"string",
            "description":"Abbreviation that identifies the unit of measure that the meter template uses. Each meter that the application creates for the asset references this value. This attribute provides a context that you can use to define, record, or view meter history. A list of accepted values is defined in the lookup type ORA_CSE_UOM_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplayedReading":{
            "title":"Displayed Reading",
            "type":"number",
            "description":"Value that's indicated on a meter. This value is the same as the Life-to-Date Reading value up until the point that a meter is reset or encounters a rollover event. For a change meter, this value is calculated by adding the current net change value to the previous displayed reading value. For an absolute meter, this value is always the same as the reading value. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date the utilization meter was last updated. The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterUsageCode":{
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that uniquely identifies whether the application created the meter reading for an asset or for a contract line. Valid values include ORA_ASSET or ORA_CONTRACT. A list of accepted values is defined in the lookup type ORA_CSE_METER_USAGE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Date the utilization meter was created. The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Meter UOM",
            "maxLength":25,
            "type":"string",
            "description":"Meaning of the unit of measure in the meter template. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverResetValue":{
            "title":"Rollover Reset Value",
            "type":"number",
            "description":"Minimum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value of RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AllowInMaintProgramFlag":{
            "title":"Allow meter to be used in generating a maintenance program forecast",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then the meter can be used for scheduling a maintenance program. If false, then the meter cannot be used for scheduling a maintenance program. The default value is false.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "maxLength":120,
            "type":"string",
            "description":"Value that identifies the subscription product. The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastReadingComments":{
            "title":"Comments",
            "maxLength":240,
            "type":"string",
            "description":"Comments of the last active meter reading in history. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingTypeCode":{
            "title":"Reading Type Code",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the type of meter reading. Each meter that the application creates for the asset references this value. This attribute specifies whether to record the meter reading as an absolute value or a change value, depending on the meter type. The application limits the combination of meter and reading type to the following usages: continuous absolute, continuous change, or gauge absolute. A list of accepted values is defined in the lookup type ORA_CSE_READING_TYPE_CODE.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResetAllowedFlag":{
            "title":"Reset allowed",
            "maxLength":1,
            "type":"boolean",
            "description":"Contains one of the following values: true or false. If true, then allow the meter template to reset the asset meter when the application records a new reading in the meter reading history. If false, then don't allow. If true, then you must define ResetValue. The default value is false. Each meter that the application creates for the asset references this value. You cannot define an indicator for a gauge meter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductNumber":{
            "maxLength":300,
            "type":"string",
            "description":"Subscription product number, The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordAtWoComplCode":{
            "title":"Record Meters at Work Order Completion",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the option that is used to control the meter reading entry at work order completion.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when the application can use the meter template for the asset. The application sets this value to the active start date for the meter that it created for the asset, by default. The date must be equal to or greater than the system date, and less than the value of the active end date.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingDirection":{
            "title":"Reading Direction",
            "maxLength":30,
            "type":"string",
            "description":"Direction of the meter reading in the meter template. Each meter that the application creates for the asset references this value. This attribute specifies the direction to record the meter reading in ascending, descending, or bidirectional direction, depending on the type of meter and type of reading. The application limits the combination of meter, reading type, and direction to the following usages: continuous absolute ascending, continuous absolute change, continuous change ascending, continuous change descending, or gauge absolute bidirectional. A list of accepted values is defined in the lookup type ORA_CSE_DIRECTION.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CalculatedUtilizationRate":{
            "title":"Calculated Utilization Rate per Day",
            "type":"number",
            "description":"Value of the calculated utilization rate based on the number of active readings in history. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Name of the maintenance work order from which the meter reading was recorded. The attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "type":"integer",
            "description":"Unique identifier of the maintenance work order from which the meter reading was recorded. The attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InitialReadingValue":{
            "title":"Initial Reading",
            "type":"number",
            "description":"Value of the initial reading from the meter definition. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingDirectionMeaning":{
            "title":"Reading Direction Meaning",
            "maxLength":80,
            "type":"string",
            "description":"Meaning of the reading direction in the meter template. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LifeToDateReading":{
            "title":"Net",
            "type":"number",
            "description":"Value that represents the cumulative reading value for an asset meter, irrespective of reset or rollover events, over time. It's incremented by the recording new meter readings. This attribute is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverMaximumValue":{
            "title":"Rollover Maximum Value",
            "type":"number",
            "description":"Maximum value that the application can set for the asset meter in the meter template when it records a new reading in the meter reading history. If RolloverAllowedFlag is true, then you must provide a value for RolloverMaximumValue. Each meter that the application creates for the asset references RolloverMaximumValue. The value in RolloverMaximumValue must be greater than zero, greater than the value of RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Asset Identifier for meter reading. The attribute is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DailyUtilizationRate":{
            "title":"Estimated Daily Utilization Rate",
            "type":"number",
            "description":"Expected average daily total of readings that are to be entered for a meter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"User that updated the utilization meter. The attribute is read-only.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top