Create warranty coverages
/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages
Request
-
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object
-
AuthorizationRequiredFlag: boolean
Title:
Requires Repair Authorization
Maximum Length:1
Default Value:false
Value that indicates whether an explicit authorization is to be sought before repair work is performed. -
coverageApplicabilities: array
Coverage Applicabilities
Title:
Coverage Applicabilities
The Coverage Applicabilities resource manages the applicabilities for a coverage. -
CoverageCode(required): string
Title:
Coverage Code
Maximum Length:80
Value that identifies the coverage. -
CoverageDescription: string
Title:
Coverage Description
Maximum Length:240
Value that specifies the coverage description. -
CoverageEndDate: string
(date)
Title:
Coverage End Date
Value that specifies the end date for a coverage. -
coverageMeters: array
Coverage Meters
Title:
Coverage Meters
The Coverage Meters resource manages the coverage meter creation for a warranty. -
CoverageName(required): string
Title:
Coverage Name
Maximum Length:120
Value that specifies the value of the coverage name. -
CoverageStartDate: string
(date)
Title:
Coverage Start Date
Value that specifies the coverage start date. -
CoverageStatusCode: string
Title:
Coverage Status Code
Maximum Length:30
Default Value:ORA_DRAFT
Value that specifies the coverage status code attribute. -
coverageTransactionCodes: array
Coverage Transaction Codes
Title:
Coverage Transaction Codes
The Coverage Transaction Codes resource manages transaction codes for a coverage. -
CoverageTypeCode: string
Title:
Coverage Type Code
Maximum Length:30
Value that specifies the coverage type code attribute. -
FilterByTxnCodeFlag: boolean
Title:
Filter by Transaction Code
Maximum Length:1
Default Value:false
Value that indicates if warranty contracts created using the warranty coverage can be filtered by their transaction codes when referenced in a warranty claim. -
InternalRepairAllowedFlag: boolean
Title:
Allows Internal Repair
Maximum Length:1
Default Value:false
Value indicating that the coverage allows work to be performed by the consumer. -
LaborReimbursementFlag: boolean
Title:
Labor Reimbursement
Maximum Length:1
Default Value:false
Value indicating whether the labor cost charged toward the repair work can be reimbursed to the provider. -
ManufacturerId: integer
(int64)
Title:
Manufacturer ID
Value that uniquely identifies the manufacturer. -
ManufacturerNumber: string
Title:
Manufacturer Number
Maximum Length:255
Value that identifies the manufacturer number that provides the warranty coverage. -
PartsReimbursementFlag: boolean
Title:
Parts Reimbursement
Maximum Length:1
Default Value:false
Value indicating whether the replacement cost for parts can be reimbursed to the provider. -
PartsReturnRequiredFlag: boolean
Title:
Parts Return Required
Maximum Length:1
Default Value:false
Value indicating whether the original part must be returned to the provider. -
ReactionsAndResolutions: string
Title:
Reactions and Resolutions
Maximum Length:4000
Value that indicates the reactions and resolutions documented by the warranty provider. -
ServiceLevelAgreements: string
Title:
Service-Level Agreements
Maximum Length:4000
Value that specifies the service level agreements with the warranty provider. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier. -
SupplierNumber: string
Title:
Supplier Number
Maximum Length:255
Value that identifies the supplier number. -
TermsAndConditions: string
Title:
Terms and Conditions
Maximum Length:4000
Value that identifies the terms and conditions of the coverage. -
UOMCode: string
Title:
Unit of Measure Code
Maximum Length:30
Duration unit type for the duration of the warranty. A list of accepted values is defined in the lookup type ORA_CSE_WTY_COVERAGES_UOM. -
WarrantyDuration: number
Title:
Warranty Duration
Value that identifies the duration of the warranty. All warranties instantiated from this coverage will inherit this duration. -
WarrantyProviderId(required): integer
(int64)
Title:
Warranty Provider ID
Value that uniquely identifies the warranty provider ID. -
WarrantyProviderNumber: string
Title:
Warranty Provider Number
Maximum Length:255
Value that identifies the warranty provider number.
array
Coverage Applicabilities
array
Coverage Meters
array
Coverage Transaction Codes
object
-
AutoAssignFlag: boolean
Title:
Autoassign
Maximum Length:1
Default Value:true
Value indicating that the warranty can be automatically created and assigned to this coverage. -
ContractDefaultStatusCode: string
Title:
Contract Default Status Code
Maximum Length:30
Value that specifies the default status code that can be assigned to the contract when the contract is auto created. -
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that specifies if the applicability is ineffective for the coverage. -
ItemId: integer
(int64)
Title:
Item ID
Value that identifies the item for which the coverage is applicable. -
ItemNumber: string
Title:
Item Number
Maximum Length:255
Value that identifies the item number for which the coverage is applicable. -
ItemOrganizationCode: string
Title:
Item Organization Code
Maximum Length:255
Value that identifies the organization to which item is applicable for this coverage. -
ItemOrganizationId: integer
(int64)
Title:
Item Organization ID
Value that identifies the covered organization. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier ID. -
SupplierNumber: string
Title:
Supplier Number
Maximum Length:255
Value that identifies the supplier number which is optionally used in matching the receipts for making the item applicable for the coverage.
object
-
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that identifies whether or not the meter is effective for the coverage. -
MeterCode: string
Title:
Meter Code
Maximum Length:255
Value that identifies the meter code for the coverage. -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition ID
Value that uniquely identifies the meter definition ID for the coverage. -
MeterIntervalValue: number
Title:
Meter Interval Value
Value that identifies the meter interval value attribute. -
MeterStartValue: number
Title:
Meter Start Value
Value that identifies the meter start value attribute.
object
-
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that indicates if the transaction code is disabled for a warranty coverage.. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:255
Value that uniquely identifies the transaction code for the coverage. -
TransactionCodeId: integer
(int64)
Title:
Transaction Code ID
Value that uniquely identifies the transaction code ID.
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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.
object
-
AuthorizationRequiredFlag: boolean
Title:
Requires Repair Authorization
Maximum Length:1
Default Value:false
Value that indicates whether an explicit authorization is to be sought before repair work is performed. -
ContractsCreatedFlag: boolean
Title:
Contracts Created
Read Only:true
Maximum Length:80
Value that indicates if warranty contracts have been created based on the warranty coverage. -
coverageApplicabilities: array
Coverage Applicabilities
Title:
Coverage Applicabilities
The Coverage Applicabilities resource manages the applicabilities for a coverage. -
CoverageCode: string
Title:
Coverage Code
Maximum Length:80
Value that identifies the coverage. -
CoverageDescription: string
Title:
Coverage Description
Maximum Length:240
Value that specifies the coverage description. -
CoverageEndDate: string
(date)
Title:
Coverage End Date
Value that specifies the end date for a coverage. -
CoverageId: integer
(int64)
Title:
Coverage ID
Read Only:true
Primary key for the asset warranty coverage business object. The application creates this value. This attribute is read-only. -
coverageMeters: array
Coverage Meters
Title:
Coverage Meters
The Coverage Meters resource manages the coverage meter creation for a warranty. -
CoverageName: string
Title:
Coverage Name
Maximum Length:120
Value that specifies the value of the coverage name. -
CoverageStartDate: string
(date)
Title:
Coverage Start Date
Value that specifies the coverage start date. -
CoverageStatus: string
Title:
Coverage Status
Read Only:true
Maximum Length:80
Abbreviation for the status of the warranty coverage. -
CoverageStatusCode: string
Title:
Coverage Status Code
Maximum Length:30
Default Value:ORA_DRAFT
Value that specifies the coverage status code attribute. -
coverageTransactionCodes: array
Coverage Transaction Codes
Title:
Coverage Transaction Codes
The Coverage Transaction Codes resource manages transaction codes for a coverage. -
CoverageType: string
Title:
Coverage Type
Read Only:true
Maximum Length:255
Coverage type description of the warranty coverage. -
CoverageTypeCode: string
Title:
Coverage Type Code
Maximum Length:30
Value that specifies the coverage type code attribute. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Column that specifies the creator of the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Column that specifies the creation date of the row. -
FilterByTxnCodeFlag: boolean
Title:
Filter by Transaction Code
Maximum Length:1
Default Value:false
Value that indicates if warranty contracts created using the warranty coverage can be filtered by their transaction codes when referenced in a warranty claim. -
InternalRepairAllowedFlag: boolean
Title:
Allows Internal Repair
Maximum Length:1
Default Value:false
Value indicating that the coverage allows work to be performed by the consumer. -
LaborReimbursementFlag: boolean
Title:
Labor Reimbursement
Maximum Length:1
Default Value:false
Value indicating whether the labor cost charged toward the repair work can be reimbursed to the provider. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Column that identifies the date and time of the last update on the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Column that identifies the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerId: integer
(int64)
Title:
Manufacturer ID
Value that uniquely identifies the manufacturer. -
ManufacturerName: string
Title:
Manufacturer Name
Read Only:true
Maximum Length:255
Value that identifies the manufacturer name. -
ManufacturerNumber: string
Title:
Manufacturer Number
Maximum Length:255
Value that identifies the manufacturer number that provides the warranty coverage. -
PartsReimbursementFlag: boolean
Title:
Parts Reimbursement
Maximum Length:1
Default Value:false
Value indicating whether the replacement cost for parts can be reimbursed to the provider. -
PartsReturnRequiredFlag: boolean
Title:
Parts Return Required
Maximum Length:1
Default Value:false
Value indicating whether the original part must be returned to the provider. -
ReactionsAndResolutions: string
Title:
Reactions and Resolutions
Maximum Length:4000
Value that indicates the reactions and resolutions documented by the warranty provider. -
ServiceLevelAgreements: string
Title:
Service-Level Agreements
Maximum Length:4000
Value that specifies the service level agreements with the warranty provider. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier. -
SupplierName: string
Title:
Supplier Name
Read Only:true
Maximum Length:360
Value that identifies the supplier name. -
SupplierNumber: string
Title:
Supplier Number
Maximum Length:255
Value that identifies the supplier number. -
TermsAndConditions: string
Title:
Terms and Conditions
Maximum Length:4000
Value that identifies the terms and conditions of the coverage. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:80
Abbreviation for the unit of measure description for the warranty duration. -
UOMCode: string
Title:
Unit of Measure Code
Maximum Length:30
Duration unit type for the duration of the warranty. A list of accepted values is defined in the lookup type ORA_CSE_WTY_COVERAGES_UOM. -
WarrantyDuration: number
Title:
Warranty Duration
Value that identifies the duration of the warranty. All warranties instantiated from this coverage will inherit this duration. -
WarrantyProviderId: integer
(int64)
Title:
Warranty Provider ID
Value that uniquely identifies the warranty provider ID. -
WarrantyProviderName: string
Title:
Warranty Provider Name
Read Only:true
Maximum Length:360
Value that identifies the warranty provider name. -
WarrantyProviderNumber: string
Title:
Warranty Provider Number
Maximum Length:255
Value that identifies the warranty provider number.
array
Coverage Applicabilities
array
Coverage Meters
array
Coverage Transaction Codes
array
Links
object
-
ActiveEndDate: string
(date)
Title:
Active End Date
Read Only:true
Value that specifies the end date for the coverage applicability. -
AutoAssignFlag: boolean
Title:
Autoassign
Maximum Length:1
Default Value:true
Value indicating that the warranty can be automatically created and assigned to this coverage. -
ContractDefaultStatus: string
Title:
Contract Default Status
Read Only:true
Maximum Length:80
Meaning for the Contract default status code that can be assigned to the contract when the contract is auto created. -
ContractDefaultStatusCode: string
Title:
Contract Default Status Code
Maximum Length:30
Value that specifies the default status code that can be assigned to the contract when the contract is auto created. -
CoverageApplicabilityId: integer
(int64)
Title:
Coverage Applicability ID
Read Only:true
Primary key for the coverage applicability business object. -
CoverageId: integer
(int64)
Title:
Coverage ID
Read Only:true
Value that uniquely identifies the coverage to which the applicability belongs. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Column for identifying the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Column that identifies the date and time of creation of the row. -
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that specifies if the applicability is ineffective for the coverage. -
ItemDescription: string
Title:
Item Description
Read Only:true
Maximum Length:240
Description for the item for which the coverage is applicable. -
ItemId: integer
(int64)
Title:
Item ID
Value that identifies the item for which the coverage is applicable. -
ItemLongDescription: string
Title:
Long Description
Read Only:true
Maximum Length:4000
Long description for the item for which the coverage is applicable. -
ItemNumber: string
Title:
Item Number
Maximum Length:255
Value that identifies the item number for which the coverage is applicable. -
ItemOrganizationCode: string
Title:
Item Organization Code
Maximum Length:255
Value that identifies the organization to which item is applicable for this coverage. -
ItemOrganizationId: integer
(int64)
Title:
Item Organization ID
Value that identifies the covered organization. -
ItemOrganizationName: string
Title:
Item Organization Name
Read Only:true
Maximum Length:255
Value that identifies the organization name to which the item is applicable for this coverage. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Column that identifies the date and time of the last update on the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Column that identifies the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplierId: integer
(int64)
Title:
Supplier ID
Value that uniquely identifies the supplier ID. -
SupplierName: string
Title:
Supplier Name
Read Only:true
Maximum Length:360
Value that identifies the supplier name which is optionally used in matching the receipts for making the item applicable for the coverage. -
SupplierNumber: string
Title:
Supplier Number
Maximum Length:255
Value that identifies the supplier number which is optionally used in matching the receipts for making the item applicable for the coverage.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object
-
ActiveEndDate: string
(date)
Title:
Active End Date
Read Only:true
Value that identifies the date on which the meter for the coverage becomes ineffective. -
CoverageId: integer
(int64)
Title:
Coverage ID
Read Only:true
Value that identifies the coverage ID to which the meter belongs. -
CoverageMeterId: integer
(int64)
Title:
Coverage Meter ID
Read Only:true
Primary key for the coverage meter ID. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Column for identifying the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Column that identifies the date and time of creation of the row. -
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that identifies whether or not the meter is effective for the coverage. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Column that identifies the date and time of the last update on the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Column that identifies the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MeterCode: string
Title:
Meter Code
Maximum Length:255
Value that identifies the meter code for the coverage. -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition ID
Value that uniquely identifies the meter definition ID for the coverage. -
MeterDescription: string
Title:
Meter Description
Read Only:true
Maximum Length:240
Value that identifies the meter description for the coverage. -
MeterIntervalValue: number
Title:
Meter Interval Value
Value that identifies the meter interval value attribute. -
MeterName: string
Title:
Meter Name
Read Only:true
Maximum Length:120
Value that identifies the meter name for the coverage. -
MeterStartValue: number
Title:
Meter Start Value
Value that identifies the meter start value attribute. -
UnitOfMeasure: string
Title:
Unit of Measure
Read Only:true
Maximum Length:255
Abbreviation for the unit of measure description for the coverage meter. -
UOMCode: string
Title:
Unit of Measure Code
Read Only:true
Maximum Length:3
Value that identifies the UOM code for the meter associated with the coverage.
array
Links
object
-
ActiveEndDate: string
(date)
Title:
Active End Date
Read Only:true
Value that identifies the date when the transaction code for the coverage becomes ineffective. -
CoverageId: integer
(int64)
Title:
Coverage ID
Read Only:true
Value that uniquely identifies the coverage ID to which the transaction code belong. -
CoverageTransactionCodeId: integer
(int64)
Title:
Coverage Transaction Code ID
Read Only:true
Value that uniquely identifies the coverage transaction code ID. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Column for identifying the user who created the row. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Column that identifies the date and time of creation of the row. -
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that indicates if the transaction code is disabled for a warranty coverage.. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Column that identifies the date and time of the last update on the row. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Column that identifies the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:255
Value that uniquely identifies the transaction code for the coverage. -
TransactionCodeDescription: string
Title:
Transaction Code Description
Read Only:true
Maximum Length:540
Value that identifies the description of the transaction code. -
TransactionCodeId: integer
(int64)
Title:
Transaction Code ID
Value that uniquely identifies the transaction code ID. -
TransactionCodeName: string
Title:
Transaction Code Name
Read Only:true
Maximum Length:240
Value that identifies name of the transaction code. -
TransactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:80
Value that identifies the meaning of the transaction code. -
TransactionTypeCode: string
Title:
Transaction Type Code
Read Only:true
Maximum Length:30
Value that uniquely identifies type of the transaction code.
array
Links
- coverageApplicabilities
-
Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageApplicabilitiesParameters:
- CoverageId:
$request.path.CoverageId
The Coverage Applicabilities resource manages the applicabilities for a coverage. - CoverageId:
- coverageMeters
-
Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageMetersParameters:
- CoverageId:
$request.path.CoverageId
The Coverage Meters resource manages the coverage meter creation for a warranty. - CoverageId:
- coverageTransactionCodes
-
Parameters:
- CoverageId:
$request.path.CoverageId
The Coverage Transaction Codes resource manages transaction codes for a coverage. - CoverageId:
Examples
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages"
Example 1
This example describes how to create a warranty coverage using number references for the provider, manufacturer and supplier. For additional examples, see the Create and Update Supplier Warranty use case.
Example 1 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.
{ "CoverageName": "ALM Coverage", "CoverageCode": "ALM_COVERAGE", "CoverageDescription": "ALM COVERAGE DESCRIPTION", "CoverageStartDate": "2022-01-01", "CoverageEndDate": "2022-12-31", "CoverageStatusCode": "ORA_READY", "CoverageTypeCode": "5YRWTY", "ManufacturerNumber": "123456", "SupplierNumber": "654321", "WarrantyProviderNumber": "123456", "WarrantyDuration": 30, "UOMCode": "ORA_DAY", "TermsAndConditions": "Defined terms and conditions", "ReactionsAndResolutions": "Defined reactions and resolutions", "ServiceLevelAgreements": "Defined service level agreements", "InternalRepairAllowedFlag": true, "AuthorizationRequiredFlag": true, "PartsReimbursementFlag": true, "PartsReturnRequiredFlag": true, "LaborReimbursementFlag": true, "FilterByTxnCodeFlag": true }
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{ "CoverageId": 300100568130739, "CoverageName": "ALM Coverage", "CoverageCode": "ALM_COVERAGE", "CoverageDescription": "ALM COVERAGEDESCRIPTION", "CoverageStartDate": "2022-01-01", "CoverageEndDate": "2023-12-31", "CoverageStatusCode": "ORA_READY", "CoverageStatus": null, "CoverageTypeCode": "NEWWTY", "CoverageType": null, "ManufacturerId": 300100120329772, "ManufacturerNumber": "123456", "ManufacturerName": null, "SupplierId": 999992000322154, "SupplierNumber": "654321", "SupplierName": null, "WarrantyProviderId": 999992000322153, "WarrantyProviderNumber": "12345678", "WarrantyProviderName": null, "WarrantyDuration": 30, "UOMCode": "ORA_DAY", "UnitOfMeasure": null, "TermsAndConditions": "Defined terms and conditions", "ReactionsAndResolutions": "Defined reactions and resolutions", "ServiceLevelAgreements": "Defined service level agreements", "InternalRepairAllowedFlag": true, "AuthorizationRequiredFlag": true, "PartsReimbursementFlag": true, "PartsReturnRequiredFlag": true, "LaborReimbursementFlag": true, "FilterByTxnCodeFlag": true, "ContractsCreatedFlag": false, "CreatedBy": "USER", "CreationDate": "2022-01-01T13:53:35+00:00", "LastUpdatedBy": "USER", "LastUpdateDate": "2022-01-01T13:53:35.001+00:00", "links": [ { "rel": "self", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item" }, { "rel": "child", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities", "name": "coverageApplicabilities", "kind": "collection" }, { "rel": "child", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageMeters", "name": "coverageMeters", "kind": "collection" }, { "rel": "child", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes", "name": "coverageTransactionCodes", "kind": "collection" } ] }
Example 2
This example describes how to create a warranty coverage using ID references for the provider, manufacturer, and supplier. For additional examples, see the Create and Update Supplier Warranty use case.
Example 2 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.
{ "CoverageName": "ALM Coverage", "CoverageCode": "ALM_COVERAGE", "CoverageDescription": "ALM COVERAGE DESCRIPTION", "CoverageStartDate": "2022-01-01", "CoverageEndDate": "2022-12-31", "CoverageStatusCode": "ORA_DRAFT", "CoverageTypeCode": "5YRWTY", "WarrantyProviderId": "999992000322153", "SupplierId": "999992000322154", "ManufacturerId": "300100120329772", "WarrantyDuration": 30, "UOMCode": "ORA_DAY", "TermsAndConditions": "Defined terms and conditions", "ReactionsAndResolutions": "Defined reactions and resolutions", "ServiceLevelAgreements": "Defined service level agreements", "InternalRepairAllowedFlag": true, "AuthorizationRequiredFlag": true, "PartsReimbursementFlag": true, "PartsReturnRequiredFlag": true, "LaborReimbursementFlag": true, "FilterByTxnCodeFlag": true }
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{ "CoverageId": 300100568130739, "CoverageName": "ALM Coverage", "CoverageCode": "ALM_COVERAGE", "CoverageDescription": "ALM COVERAGEDESCRIPTION", "CoverageStartDate": "2022-01-01", "CoverageEndDate": "2023-12-31", "CoverageStatusCode": "ORA_READY", "CoverageStatus": null, "CoverageTypeCode": "NEWWTY", "CoverageType": null, "ManufacturerId": 300100120329772, "ManufacturerNumber": "123456", "ManufacturerName": null, "SupplierId": 999992000322154, "SupplierNumber": "654321", "SupplierName": null, "WarrantyProviderId": 999992000322153, "WarrantyProviderNumber": "12345678", "WarrantyProviderName": null, "WarrantyDuration": 30, "UOMCode": "ORA_DAY", "UnitOfMeasure": null, "TermsAndConditions": "Defined terms and conditions", "ReactionsAndResolutions": "Defined reactions and resolutions", "ServiceLevelAgreements": "Defined service level agreements", "InternalRepairAllowedFlag": true, "AuthorizationRequiredFlag": true, "PartsReimbursementFlag": true, "PartsReturnRequiredFlag": true, "LaborReimbursementFlag": true, "FilterByTxnCodeFlag": true, "ContractsCreatedFlag": false, "CreatedBy": "USER", "CreationDate": "2022-01-01T13:53:35+00:00", "LastUpdatedBy": "USER", "LastUpdateDate": "2022-01-01T13:53:35.001+00:00", "links": [ { "rel": "self", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item" }, { "rel": "child", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities", "name": "coverageApplicabilities", "kind": "collection" }, { "rel": "child", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageMeters", "name": "coverageMeters", "kind": "collection" }, { "rel": "child", "href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes", "name": "coverageTransactionCodes", "kind": "collection" } ] }