REST API for Oracle Fusion Cloud SCM

Update a contract meter

patch

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

Request

Path Parameters

ContractId(required): integer(int64)

Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
ContractMeterId(required): integer(int64)

Value that uniquely identifies the warranty contract meter. The application creates this value when it creates the contract meter.

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.

Supported Media Types

application/json

Root Schema : schema

Type: object

Show Source

DisabledFlag: boolean

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.
MeterCode: string

Title: Meter Code

Maximum Length: 30

Abbreviation that uniquely identifies a meter definition in a warranty contract.
MeterIntervalValue: number

Title: Meter Interval Value

The interval value for a meter in a warranty contract.
MeterStartValue: number

Title: Meter Start Value

The start value for a meter in a warranty contract.

{
    "type":"object",
    "properties":{
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Flag that is used to set the active end date of the contract meters.Valid values are Y and N.",
            "nullable":true
        },
        "MeterCode":{
            "title":"Meter Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies a meter definition in a warranty contract.",
            "nullable":true
        },
        "MeterStartValue":{
            "title":"Meter Start Value",
            "type":"number",
            "description":"The start value for a meter in a warranty contract.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "MeterIntervalValue":{
            "title":"Meter Interval Value",
            "type":"number",
            "description":"The interval value for a meter in a warranty contract.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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.

Root Schema : assetWarrantyContracts-contractMeters-item-response

Type: object

Show Source

ActiveEndDate: string (date)

Title: Active End Date

Read Only: true

Date that indicates if a meter definition is disabled for a warranty contract.
CalculatedDueDate: string (date)

Title: Calculated End Date

Read Only: true

The calculated contract due date value in a warranty contract.
ContractId: integer (int64)

Read Only: true

Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
ContractMeterId: integer (int64)

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.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

Login user name of the user who created the record.
CreationDate: string (date-time)

Title: Creation Date

Read Only: true

Date when the record was created.
DisabledFlag: boolean

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.
LastUpdateDate: string (date-time)

Title: Last Update Date

Read Only: true

Date when the record was updated.
LastUpdatedBy: string

Title: Last Updated By

Read Only: true

Maximum Length: 64

Login user name of the user who updated the record.
links: array Links

Title: Links

The link relations associated with the resource instance.
MeterCode: string

Title: Meter Code

Maximum Length: 30

Abbreviation that uniquely identifies a meter definition in a warranty contract.
MeterDescription: string

Title: Meter Description

Read Only: true

Maximum Length: 240

The description of a meter definition.
MeterEndValue: number

Title: Meter End Value

Read Only: true

End value for a meter in a warranty contract.
MeterId: integer (int64)

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.
MeterIntervalValue: number

Title: Meter Interval Value

The interval value for a meter in a warranty contract.
MeterName: string

Title: Contract Meter Name

Read Only: true

Maximum Length: 120

The name of a meter definition.
MeterStartValue: number

Title: Meter Start Value

The start value for a meter in a warranty contract.
UnitOfMeasure: string

Title: Unit of Measure

Read Only: true

Maximum Length: 25

Name of the unit of measure for the warranty.
UOMCode: string

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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Login user name of the user who updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CalculatedDueDate":{
            "title":"Calculated End Date",
            "type":"string",
            "description":"The calculated contract due date value in a warranty contract.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Login user name of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"25",
            "type":"string",
            "description":"Name of the unit of measure for the warranty.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "controlType":"edit"
            },
            "x-queryable":true
        },
        "MeterCode":{
            "title":"Meter Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies a meter definition in a warranty contract.",
            "nullable":true,
            "x-queryable":true
        },
        "MeterStartValue":{
            "title":"Meter Start Value",
            "type":"number",
            "description":"The start value for a meter in a warranty contract.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContractMeterId":{
            "title":"Contract Meter ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty contract meter. The application creates this value when it creates the contract meter.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContractId":{
            "type":"integer",
            "description":"Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeterDescription":{
            "title":"Meter Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of a meter definition.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeterId":{
            "title":"Meter ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter definition in a warranty contract.  The meter must be active for the asset number referenced in the contract.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Flag that is used to set the active end date of the contract meters.Valid values are Y and N.",
            "nullable":true,
            "x-queryable":true
        },
        "MeterName":{
            "title":"Contract Meter Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of a meter definition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterIntervalValue":{
            "title":"Meter Interval Value",
            "type":"number",
            "description":"The interval value for a meter in a warranty contract.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":"3",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Date that indicates if a meter definition is disabled for a warranty contract.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeterEndValue":{
            "title":"Meter End Value",
            "type":"number",
            "description":"End value for a meter in a warranty contract.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Date when the record was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "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."
        }
    }
}

Examples

This example describes how to update a contract meter for a warranty contract..

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/ContractId/child/contractMeters/ContractMeterId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
"MeterIntervalValue": 1000
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "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": 1000,
    "MeterEndValue": 1000,
    "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/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"
        }
    ]
}