Jump to

• Request
• Response
• Examples

Get one template

get

/fscmRestApi/resources/11.13.18.05/meterTemplates/{MeterDefinitionId}

Request

Path Parameters

• MeterDefinitionId(required): integer(int64)
  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.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• 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
• 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
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

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 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 : meterTemplates-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "RolloverAllowedFlag":{
            "title":"Rollover allowed",
            "maxLength":"1",
            "type":"boolean",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "MeterType":{
            "title":"Meter Type",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterTypeCode":{
            "title":"Meter Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "MeterCode":{
            "title":"Meter Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "MetersCreatedFlag":{
            "title":"Meters Created",
            "maxLength":"255",
            "type":"boolean",
            "description":"Indicates if the meter template has been used to create one or more meters for an asset.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "MeterDescription":{
            "title":"Meter Description",
            "maxLength":"240",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ReadingType":{
            "title":"Reading Type",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingMinimumValue":{
            "title":"Reading Minimum Value",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "MeterName":{
            "title":"Meter Name",
            "maxLength":"120",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "UtilizationRateComputedAt":{
            "title":"Number of Readings to Calculate an Average Daily Utilization Rate",
            "type":"integer",
            "description":"Number of readings to consider when calculating the utilization rate.",
            "nullable":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":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "UOMCode":{
            "title":"Meter UOM",
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "title":"Status",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies if the meter is ready or expired.",
            "nullable":true,
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"25",
            "type":"string",
            "description":"Associated descriptive name of the unit of measure code for the meter template definition that is returned after creation or retrieval.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "RolloverResetValue":{
            "title":"Rollover Minimum Value",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowInMaintProgramFlag":{
            "title":"Allow meter to be used in generating a maintenance program forecast",
            "maxLength":"1",
            "type":"boolean",
            "description":"Determines whether you can use the meter for maintenance.",
            "nullable":false,
            "default":false,
            "x-queryable":true
        },
        "ReadingTypeCode":{
            "title":"Reading Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ReadingMaximumValue":{
            "title":"Reading Maximum Value",
            "type":"number",
            "description":"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.",
            "nullable":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 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.",
            "nullable":false,
            "x-queryable":true
        },
        "RecordAtWoCompletion":{
            "title":"Record Meters at Work Order Completion",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning that identifies if the application requires the meter recording while completing the work order.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverAllowed":{
            "title":"Rollover allowed",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterApplicability":{
            "title":"Applicabilities",
            "type":"array",
            "description":"The Applicabilities resource allows you to apply items to a meter.",
            "items":{
                "$ref":"#/components/schemas/meterTemplates-MeterApplicability-item-response"
            }
        },
        "RecordAtWoComplCode":{
            "title":"Record Meters at Work Order Completion",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies whether the application requires the meter recording while completing the work order.",
            "nullable":true,
            "default":"ORA_DO_NOT_ALLOW",
            "x-queryable":true
        },
        "ReadingDirection":{
            "title":"Reading Direction",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"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.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "ResetAllowed":{
            "title":"Reset allowed",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InitialReadingValue":{
            "title":"Initial Reading",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ReadingDirectionMeaning":{
            "title":"Reading Direction Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverMaximumValue":{
            "title":"Rollover Maximum Value",
            "type":"number",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "DailyUtilizationRate":{
            "title":"Estimated Daily Utilization Rate",
            "type":"number",
            "description":"Base utilization rate for each day. The application uses this attribute only if it does not calculate the daily utilization rate for the meter.",
            "nullable":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 : Applicabilities

Type: array

Title: Applicabilities

The Applicabilities resource allows you to apply items to a meter.

Show Source

• Array of: object meterTemplates-MeterApplicability-item-response

{
    "title":"Applicabilities",
    "type":"array",
    "description":"The Applicabilities resource allows you to apply items to a meter.",
    "items":{
        "$ref":"#/components/schemas/meterTemplates-MeterApplicability-item-response"
    }
}

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."
        }
    }
}

Nested Schema : meterTemplates-MeterApplicability-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "MasterOrganizationCode":{
            "title":"Master Organization",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that identifies the organization where the work order creates the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ActiveStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"Date when to start using the item to create a meter for a new asset.",
            "format":"date-time",
            "nullable":false,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"300",
            "type":"string",
            "description":"Number that identifies the item.",
            "nullable":true,
            "x-queryable":true
        },
        "MasterOrganizationId":{
            "title":"Master Organization",
            "type":"integer",
            "description":"Value that uniquely identifies the organization where the work order creates the item.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the object version.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the item that the meter measures.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the item that the meter measures.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"Date when to stop using the item to create a meter for a new asset.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ApplicabilityId":{
            "title":"Applicability ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter applicability.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"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"
    }
}

Links

MeterApplicability

Operation: /fscmRestApi/resources/11.13.18.05/meterTemplates/{MeterDefinitionId}/child/MeterApplicability

Parameters:

• MeterDefinitionId: $request.path.MeterDefinitionId

The Applicabilities resource allows you to apply items to a meter.

Back to Top

Examples

This example describes how to get one meter template.

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/MeterDefinitionId"

For example:

curl -u username:password "https://servername/fscmRestApi/resources/version/meterTemplates/300100584894642"

Example Response Body

The following shows an example of the response body in JSON format.

{
    "MeterDefinitionId": 300100584894642,
    "MeterCode": "SP_TEMP16",
    "MeterName": "SP_TEMP16",
    "MeterDescription": null,
    "UOMCode": "EA",
    "UnitOfMeasure": "EA",
    "MeterTypeCode": "ORA_CONTINUOUS",
    "MeterType": "Continuous",
    "ReadingTypeCode": "ORA_CHANGE",
    "ReadingType": "Change",
    "ReadingDirection": "ORA_ASCENDING",
    "ReadingDirectionMeaning": "Ascending",
    "ActiveStartDate": "2023-01-16T07:00:00+00:00",
    "ActiveEndDate": null,
    "InitialReadingValue": 0,
    "ReadingMinimumValue": null,
    "ReadingMaximumValue": null,
    "ResetAllowedFlag": true,
    "ResetValue": 0,
    "RolloverAllowedFlag": true,
    "RolloverMaximumValue": 100,
    "RolloverResetValue": 0,
    "RolloverAllowed": "Yes",
    "ResetAllowed": "Yes",
    "DailyUtilizationRate": null,
    "AllowInMaintProgramFlag": false,
    "RecordAtWoComplCode": "ORA_DO_NOT_ALLOW",
    "RecordAtWoCompletion": "Do not allow",
    "UtilizationRateComputedAt": null,
    "MetersCreatedFlag": false,
    "Status": "Ready",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/meterTemplates/300100584894642",
            "name": "meterTemplates",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/meterTemplates/300100584894642",
            "name": "meterTemplates",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/meterTemplates/300100584894642/child/MeterApplicability",
            "name": "MeterApplicability",
            "kind": "collection"
        }
    ]
}

Back to Top