Jump to

• Request
• Response

Get one meter

get

/fscmRestApi/resources/11.13.18.05/customerAssets/{AssetId}/child/AssetMeter/{MeterId}

Request

Path Parameters

• AssetId(required): integer(int64)
  Value that uniquely identifies the asset. The application creates this value from the asset number when it creates the asset. This attribute is read-only.
• MeterId(required): integer(int64)
  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.

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 : customerAssets-AssetMeter-item-response

Type: object

Show Source

• ActiveEndDate: string (date-time)
  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 in attribute ActiveStartDate.
• ActiveStartDate: string (date-time)
  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 in attribute ActiveEndDate.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeterCode: string
  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)
  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
  Read Only: true

  Maximum Length: 240

  Description of the meter template. Each meter that the application creates and displays in the contextual action area for the meter that references this value.
• MeterId: integer (int64)
  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
  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 attributes MeterName and MeterCode 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.
• MeterTypeCode: string
  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 MeterCode are continuous, similar to an odometer, or a gauge, similar to a thermometer. You can use the ORA_CSE_METER_TYPE_CODE lookup to examine the values that this attribute uses.
• 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. Contains one of the following values: ORA_ASSET or ORA_CONTRACT. You can use the ORA_CSE_METER_USAGE_CODE lookup to examine the values that this attribute uses.
• ReadingDirection: string
  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. ReadingDirection specifies 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. You can use the ORA_CSE_DIRECTION lookup to examine the values that this attribute uses.
• ReadingTypeCode: string
  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. ReadingTypeCode 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. You can use the ORA_CSE_READING_TYPE_CODE lookup to examine the values that this attribute uses.
• ResetAllowedFlag: boolean
  Read Only: true

  Maximum Length: 1

  Contains one of the following values. 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 do not allow. If true, then you must define attribute 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
  Read Only: true

  Reset value for the meter in the meter template. The application uses ResetValue as the reset value when it records the meter reading history. If you set attribute ResetAllowedFlag to true, then you must specify a value for attribute ResetValue. Each meter that the application creates for the asset references ResetValue. ResetValue 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
  Read Only: true

  Maximum Length: 1

  Contains one of the following values. 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 do not allow rollover. If true, then you must also specify values for attributes 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.
• RolloverMaximumValue: number
  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 attribute 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 in attribute RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.
• RolloverResetValue: number
  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 attribute RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value in RolloverResetValue must be greater than or equal to zero, and must equal the minimum value that the physical meter allows for the asset.
• UOMCode: string
  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. UOMCode provides a context that you can use to define, record, or view meter history. You can use the ORA_CSE_UOM_CODE lookup to examine the values that this attribute uses.

{
    "type":"object",
    "properties":{
        "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.  Contains one of the following values: ORA_ASSET or ORA_CONTRACT. You can use the ORA_CSE_METER_USAGE_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverAllowedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. 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 do not allow rollover. If true, then you must also specify values for attributes 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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverResetValue":{
            "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 attribute RolloverAllowedFlag is true, then you must provide a value for RolloverResetValue. Each meter that the application creates for the asset references RolloverResetValue. The value in 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
        },
        "MeterTypeCode":{
            "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 MeterCode are continuous, similar to an odometer, or a gauge, similar to a thermometer. You can use the ORA_CSE_METER_TYPE_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterCode":{
            "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":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ReadingTypeCode":{
            "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. ReadingTypeCode 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. You can use the ORA_CSE_READING_TYPE_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResetAllowedFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Contains one of the following values. 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 do not allow. If true, then you must define attribute 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":false,
            "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.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "MeterDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the meter template. Each meter that the application creates and displays in the contextual action area for the meter that references this value.",
            "nullable":true,
            "readOnly":true,
            "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":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActiveStartDate":{
            "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 in attribute ActiveEndDate.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "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":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReadingDirection":{
            "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. ReadingDirection specifies 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. You can use the ORA_CSE_DIRECTION lookup to examine the values that this attribute uses.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterName":{
            "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 attributes MeterName and MeterCode provide a unique value that identifies the meter template.",
            "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":{
            "type":"number",
            "description":"Reset value for the meter in the meter template. The application uses ResetValue as the reset value when it records the meter reading history. If you set attribute ResetAllowedFlag to true, then you must specify a value for attribute ResetValue. Each meter that the application creates for the asset references ResetValue. ResetValue 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
        },
        "ActiveEndDate":{
            "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 in attribute ActiveStartDate.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UOMCode":{
            "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. UOMCode provides a context that you can use to define, record, or view meter history. You can use the ORA_CSE_UOM_CODE lookup to examine the values that this attribute uses.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RolloverMaximumValue":{
            "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 attribute 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 in attribute RolloverResetValue, and must equal the maximum cumulative value that the physical meter allows for the asset.",
            "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