Update
patch
/fscmRestApi/resources/11.13.18.05/assetWarrantyContracts/{ContractId}
Request
Path Parameters
-
ContractId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
CalculatedExpirationDate: string
(date)
Title:
Contract Calculated Expiration Date -
ContractEndDate: string
(date)
Title:
Contract End Date -
contractMeters: array
Contract Meters
Title:
Contract Meters -
ContractNotes: string
Title:
Contract NotesMaximum Length:2000 -
ContractStartDate: string
(date)
Title:
Contract Start Date -
ContractStatusCode: string
Title:
Contract Status CodeMaximum Length:30Default Value:ORA_READY -
CoverageCode: string
Title:
Coverage CodeMaximum Length:80 -
ExternalReferenceNumber: string
Title:
Contract External Reference NumberMaximum Length:80
Nested Schema : assetWarrantyContracts-contractMeters-item-patch-request
Type:
Show Source
object-
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
MeterCode: string
Title:
Meter CodeMaximum Length:30 -
MeterIntervalValue: number
Title:
Meter Interval Value -
MeterStartValue: number
Title:
Meter Start Value
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-item-response
Type:
Show Source
object-
AssetId: integer
(int64)
Read Only:
true -
AssetNumber: string
Title:
Asset NumberMaximum Length:80 -
AssetSerialNumber: string
Title:
Asset Serial NumberRead Only:trueMaximum Length:80 -
CalculatedExpirationDate: string
(date)
Title:
Contract Calculated Expiration Date -
ContractEndDate: string
(date)
Title:
Contract End Date -
ContractId: integer
(int64)
Title:
Contract IDRead Only:true -
contractMeters: array
Contract Meters
Title:
Contract Meters -
ContractNotes: string
Title:
Contract NotesMaximum Length:2000 -
ContractNumber: string
Title:
Contract NumberMaximum Length:80 -
ContractStartDate: string
(date)
Title:
Contract Start Date -
ContractStatus: string
Title:
Contract Status Code DescriptionRead Only:trueMaximum Length:80 -
ContractStatusCode: string
Title:
Contract Status CodeMaximum Length:30Default Value:ORA_READY -
CoverageCode: string
Title:
Coverage CodeMaximum Length:80 -
CoverageDescription: string
Title:
Coverage DescriptionRead Only:trueMaximum Length:240 -
CoverageId: integer
(int64)
Title:
Coverage ID -
CoverageName: string
Title:
Coverage NameRead Only:trueMaximum Length:120 -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
ExternalReferenceNumber: string
Title:
Contract External Reference NumberMaximum Length:80 -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectId: integer
(int64)
Title:
Object ID -
ObjectType: string
Title:
Object TypeRead Only:trueMaximum Length:80 -
ObjectTypeCode: string
Title:
Object Type CodeMaximum Length:30 -
RootAssetId: integer
(int64)
Read Only:
true -
RootAssetNumber: string
Read Only:
trueMaximum Length:80 -
WarrantyProviderName: string
Title:
Warranty Provider NameRead Only:trueMaximum Length:360 -
WarrantyProviderNumber: string
Title:
Warranty Provider NumberRead Only:trueMaximum Length:30
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : assetWarrantyContracts-contractMeters-item-response
Type:
Show Source
object-
ActiveEndDate: string
(date)
Title:
Active End DateRead Only:true -
CalculatedDueDate: string
(date)
Title:
Calculated End DateRead Only:true -
ContractId: integer
(int64)
Read Only:
true -
ContractMeterId: integer
(int64)
Title:
Contract Meter IDRead Only:true -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MeterCode: string
Title:
Meter CodeMaximum Length:30 -
MeterDescription: string
Title:
Meter DescriptionRead Only:trueMaximum Length:240 -
MeterEndValue: number
Title:
Meter End ValueRead Only:true -
MeterId: integer
(int64)
Title:
Meter ID -
MeterIntervalValue: number
Title:
Meter Interval Value -
MeterName: string
Title:
Contract Meter NameRead Only:trueMaximum Length:120 -
MeterStartValue: number
Title:
Meter Start Value -
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:25 -
UOMCode: string
Title:
Unit of Measure CodeRead Only:trueMaximum Length:3
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- contractMeters
-
Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyContracts/{ContractId}/child/contractMetersParameters:
- ContractId:
$request.path.ContractId
- ContractId:
Examples
This example describes how to update one 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"
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.
{
"ContractStartDate": "2022-10-15"
}
Example Response Body
The following example includes the contents of the response
body in JSON format:
{
"ContractId": 300100568130806,
"ContractNumber": "300100568130806",
"CoverageId": 300100568130805,
"CoverageName": "ALM Coverage Dur Only",
"CoverageCode": "ALM_COVERAGE_D",
"CoverageDescription": "ALM COVERAGE Duration Only",
"WarrantyProviderNumber": "654231",
"WarrantyProviderName": "Provider2",
"ObjectId": 300100566813034,
"ObjectTypeCode": "ORA_ASSET",
"ObjectType": "Asset",
"AssetNumber": "ALM_ASSET_001",
"AssetSerialNumber": null,
"ContractStatusCode": "ORA_READY",
"ContractStatus": "Ready",
"ContractStartDate": "2022-10-15",
"ContractEndDate": "2022-10-31",
"CalculatedExpirationDate": null,
"ExternalReferenceNumber": null,
"ContractNotes": null,
"CreatedBy": "USER",
"CreationDate": "2022-10-28T15:46:26+00:00",
"LastUpdateDate": "2022-10-28T15:46:26.001+00:00",
"LastUpdatedBy": "USER",
"links": [
{
"rel": "self",
"href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904",
"name": "assetWarrantyContracts",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904",
"name": "assetWarrantyContracts",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904/child/contractMeters",
"name": "contractMeters",
"kind": "collection"
}
]
}