Get all contract meters

get

/fscmRestApi/resources/11.13.18.05/assetWarrantyContracts/{ContractId}/child/contractMeters

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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:

    • PrimaryKey: Finds contract meters according to the contract meter identifier.
      Finder Variables:
      • ContractMeterId; integer; Value that uniquely identifies the contract meter.
  • 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.
  • 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
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • 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
  • 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 that indicates if a meter definition is disabled for a warranty contract.
    • CalculatedDueDate; string; The calculated contract due date value in a warranty contract.
    • ContractId; integer; Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
    • ContractMeterId; integer; Value that uniquely identifies the warranty contract meter. The application creates this value when it creates the contract meter.
    • CreatedBy; string; Login user name of the user who created the record.
    • CreationDate; string; Date when the record was created.
    • DisabledFlag; boolean; Flag that is used to set the active end date of the contract meters.Valid values are Y and N.
    • LastUpdateDate; string; Date when the record was updated.
    • LastUpdatedBy; string; Login user name of the user who updated the record.
    • MeterCode; string; Abbreviation that uniquely identifies a meter definition in a warranty contract.
    • MeterDescription; string; The description of a meter definition.
    • MeterEndValue; number; End value for a meter in a warranty contract.
    • MeterId; integer; Value that uniquely identifies the meter definition in a warranty contract. The meter must be active for the asset number referenced in the contract.
    • MeterIntervalValue; number; The interval value for a meter in a warranty contract.
    • MeterName; string; The name of a meter definition.
    • MeterStartValue; number; The start value for a meter in a warranty contract.
    • UOMCode; string; Abbreviation that uniquely identifies the unit of measure for the meter. A list of accepted values is defined in the lookup type TBD. This attribute is required if the Duration is defined, else it is optional.
    • UnitOfMeasure; string; Name of the unit of measure for the warranty.
  • 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
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : assetWarrantyContracts-contractMeters
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : assetWarrantyContracts-contractMeters-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Date that indicates if a meter definition is disabled for a warranty contract.
  • Title: Calculated End Date
    Read Only: true
    The calculated contract due date value in a warranty contract.
  • Read Only: true
    Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
  • Title: Contract Meter ID
    Read Only: true
    Value that uniquely identifies the warranty contract meter. The application creates this value when it creates the contract meter.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Login user name of the user who created the record.
  • Title: Creation Date
    Read Only: true
    Date when the record was created.
  • Title: Disabled Indicator
    Maximum Length: 80
    Flag that is used to set the active end date of the contract meters.Valid values are Y and N.
  • Title: Last Update Date
    Read Only: true
    Date when the record was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login user name of the user who updated the record.
  • Links
  • Title: Meter Code
    Maximum Length: 30
    Abbreviation that uniquely identifies a meter definition in a warranty contract.
  • Title: Meter Description
    Read Only: true
    Maximum Length: 240
    The description of a meter definition.
  • Title: Meter End Value
    Read Only: true
    End value for a meter in a warranty contract.
  • Title: Meter ID
    Value that uniquely identifies the meter definition in a warranty contract. The meter must be active for the asset number referenced in the contract.
  • Title: Meter Interval Value
    The interval value for a meter in a warranty contract.
  • Title: Contract Meter Name
    Read Only: true
    Maximum Length: 120
    The name of a meter definition.
  • Title: Meter Start Value
    The start value for a meter in a warranty contract.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the warranty.
  • Title: Unit of Measure Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that uniquely identifies the unit of measure for the meter. A list of accepted values is defined in the lookup type TBD. This attribute is required if the Duration is defined, else it is optional.
Back to Top

Examples

This example describes how to get all the contract meters for a warranty contract.

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/assetWarrantyContracts/ContractId/child/contractMeters"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "items": [
        {
            "ContractMeterId": 100100907385960,
            "ContractId": 300100568130910,
            "MeterId": 300100566813039,
            "MeterCode": "METER_TEMP_CODE_ABS_ASC_1",
            "MeterName": "METER_TEMP_CODE_ABS_ASC_1",
            "MeterDescription": "METER_TEMP_CODE_ABS_ASC_1",
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "MeterStartValue": 0,
            "MeterIntervalValue": 500,
            "MeterEndValue": 500,
            "CalculatedDueDate": "2022-10-16",
            "ActiveEndDate": null,
            "DisabledFlag": false,
            "CreatedBy": "USER",
            "CreationDate": "2022-10-28T15:58:19+00:00",
            "LastUpdateDate": "2022-10-28T16:12:03+00:00",
            "LastUpdatedBy": "USER",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters/100100907385960",
                    "name": "contractMeters",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters/100100907385960",
                    "name": "contractMeters",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910",
                    "name": "assetWarrantyContracts",
                    "kind": "item"
                }
            ]
        },
        {
            "ContractMeterId": 300100568130911,
            "ContractId": 300100568130910,
            "MeterId": 300100568132822,
            "MeterCode": "METER_TEMP_CODE_ABS_ASC_2",
            "MeterName": "METER_TEMP_CODE_ABS_ASC_2",
            "MeterDescription": "METER_TEMP_CODE_ABS_ASC_2",
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "MeterStartValue": 0,
            "MeterIntervalValue": 100000,
            "MeterEndValue": 100000,
            "CalculatedDueDate": "2028-04-19",
            "ActiveEndDate": null,
            "DisabledFlag": false,
            "CreatedBy": "USER",
            "CreationDate": "2022-10-28T16:06:14+00:00",
            "LastUpdateDate": "2022-10-28T16:12:03+00:00",
            "LastUpdatedBy": "USER",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters/300100568130911",
                    "name": "contractMeters",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters/300100568130911",
                    "name": "contractMeters",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910",
                    "name": "assetWarrantyContracts",
                    "kind": "item"
                }
            ]
        },
        {
            "ContractMeterId": 300100568130912,
            "ContractId": 300100568130910,
            "MeterId": 300100568132826,
            "MeterCode": "METER_TEMP_CODE_ABS_ASC_3",
            "MeterName": "METER_TEMP_CODE_ABS_ASC_3",
            "MeterDescription": "METER_TEMP_CODE_ABS_ASC_3",
            "UOMCode": "Ea",
            "UnitOfMeasure": "Each",
            "MeterStartValue": 0,
            "MeterIntervalValue": 100000,
            "MeterEndValue": 100000,
            "CalculatedDueDate": "2028-04-19",
            "ActiveEndDate": null,
            "DisabledFlag": false,
            "CreatedBy": "USER",
            "CreationDate": "2022-10-28T16:12:03+00:00",
            "LastUpdateDate": "2022-10-28T16:12:03+00:00",
            "LastUpdatedBy": "USER",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters/300100568130912",
                    "name": "contractMeters",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters/300100568130912",
                    "name": "contractMeters",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910",
                    "name": "assetWarrantyContracts",
                    "kind": "item"
                }
            ]
        }
    ],
    "count": 3,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130910/child/contractMeters",
            "name": "contractMeters",
            "kind": "collection"
        }
    ]
}
Back to Top