Jump to

• Request
• Response
• Examples

Update one warranty coverage

patch

/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}

Request

Path Parameters

• CoverageId(required): integer(int64)
  Primary key for the asset warranty coverage business object. The application creates this value. This attribute is read-only.

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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: 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: 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: 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.

{
    "type":"object",
    "properties":{
        "CoverageEndDate":{
            "title":"Coverage End Date",
            "type":"string",
            "description":"Value that specifies the end date for a coverage.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ReactionsAndResolutions":{
            "title":"Reactions and Resolutions",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the reactions and resolutions documented by the warranty provider.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "coverageApplicabilities":{
            "title":"Coverage Applicabilities",
            "type":"array",
            "description":"The Coverage Applicabilities resource manages the applicabilities for a coverage.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyCoverages-coverageApplicabilities-item-patch-request"
            }
        },
        "ManufacturerId":{
            "title":"Manufacturer ID",
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "CoverageName":{
            "title":"Coverage Name",
            "maxLength":"120",
            "type":"string",
            "description":"Value that specifies the value of the coverage name.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CoverageDescription":{
            "title":"Coverage Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that specifies the coverage description.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "AuthorizationRequiredFlag":{
            "title":"Requires Repair Authorization",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates whether an explicit authorization is to be sought before repair work is performed.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "FilterByTxnCodeFlag":{
            "title":"Filter by Transaction Code",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates if warranty contracts created using the warranty coverage can be filtered by their transaction codes when referenced in a warranty claim.",
            "nullable":true,
            "default":false
        },
        "coverageTransactionCodes":{
            "title":"Coverage Transaction Codes",
            "type":"array",
            "description":"The Coverage Transaction Codes resource manages transaction codes for a coverage.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyCoverages-coverageTransactionCodes-item-patch-request"
            }
        },
        "PartsReturnRequiredFlag":{
            "title":"Parts Return Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating whether the original part must be returned to the provider.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "InternalRepairAllowedFlag":{
            "title":"Allows Internal Repair",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating that the  coverage allows work to be performed by the consumer.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "UOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CoverageTypeCode":{
            "title":"Coverage Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the coverage type code attribute.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CoverageCode":{
            "title":"Coverage Code",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the coverage.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "TermsAndConditions":{
            "title":"Terms and Conditions",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the terms and conditions of the coverage.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "LaborReimbursementFlag":{
            "title":"Labor Reimbursement",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating whether the labor cost charged toward the repair work can be reimbursed to the provider.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "PartsReimbursementFlag":{
            "title":"Parts Reimbursement",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating whether the replacement cost for parts can be reimbursed to the provider.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the supplier number.",
            "nullable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the warranty provider number.",
            "nullable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "CoverageStatusCode":{
            "title":"Coverage Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the coverage status code attribute.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ManufacturerNumber":{
            "title":"Manufacturer Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the manufacturer number that provides the warranty coverage.",
            "nullable":true
        },
        "WarrantyDuration":{
            "title":"Warranty Duration",
            "type":"number",
            "description":"Value that identifies the duration of the warranty. All warranties instantiated from this coverage will inherit this duration.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "CoverageStartDate":{
            "title":"Coverage Start Date",
            "type":"string",
            "description":"Value that specifies the coverage start date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ServiceLevelAgreements":{
            "title":"Service-Level Agreements",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that specifies the service level agreements with the warranty provider.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "WarrantyProviderId":{
            "title":"Warranty Provider ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "coverageMeters":{
            "title":"Coverage  Meters",
            "type":"array",
            "description":"The Coverage Meters resource manages the coverage meter creation for a warranty.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyCoverages-coverageMeters-item-patch-request"
            }
        }
    }
}

Nested Schema : Coverage Applicabilities

Type: array

Title: Coverage Applicabilities

The Coverage Applicabilities resource manages the applicabilities for a coverage.

Show Source

• Array of: object assetWarrantyCoverages-coverageApplicabilities-item-patch-request

{
    "title":"Coverage Applicabilities",
    "type":"array",
    "description":"The Coverage Applicabilities resource manages the applicabilities for a coverage.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyCoverages-coverageApplicabilities-item-patch-request"
    }
}

Nested Schema : Coverage Meters

Type: array

Title: Coverage Meters

The Coverage Meters resource manages the coverage meter creation for a warranty.

Show Source

• Array of: object assetWarrantyCoverages-coverageMeters-item-patch-request

{
    "title":"Coverage  Meters",
    "type":"array",
    "description":"The Coverage Meters resource manages the coverage meter creation for a warranty.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyCoverages-coverageMeters-item-patch-request"
    }
}

Nested Schema : Coverage Transaction Codes

Type: array

Title: Coverage Transaction Codes

The Coverage Transaction Codes resource manages transaction codes for a coverage.

Show Source

• Array of: object assetWarrantyCoverages-coverageTransactionCodes-item-patch-request

{
    "title":"Coverage Transaction Codes",
    "type":"array",
    "description":"The Coverage Transaction Codes resource manages transaction codes for a coverage.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyCoverages-coverageTransactionCodes-item-patch-request"
    }
}

Nested Schema : assetWarrantyCoverages-coverageApplicabilities-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "ItemOrganizationId":{
            "title":"Item Organization ID",
            "type":"integer",
            "description":"Value that identifies the covered organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "ContractDefaultStatusCode":{
            "title":"Contract Default Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the default status code that can be assigned to the contract when the contract is auto created.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that specifies if the applicability is ineffective for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the item number for which the coverage is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemOrganizationCode":{
            "title":"Item Organization Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the organization to which item is applicable for this coverage.",
            "nullable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the supplier number which is optionally used in matching the receipts for making the item applicable for the coverage.",
            "nullable":true
        },
        "AutoAssignFlag":{
            "title":"Autoassign",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating that the warranty can be automatically created and assigned to this coverage.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that identifies the item for which the coverage is applicable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : assetWarrantyCoverages-coverageMeters-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter definition ID for the coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that identifies whether or not the meter is effective for the coverage.",
            "nullable":true
        },
        "MeterCode":{
            "title":"Meter Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the meter code for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterStartValue":{
            "title":"Meter Start Value",
            "type":"number",
            "description":"Value that identifies the meter start value attribute.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        },
        "MeterIntervalValue":{
            "title":"Meter Interval Value",
            "type":"number",
            "description":"Value that identifies the meter interval value attribute.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            }
        }
    }
}

Nested Schema : assetWarrantyCoverages-coverageTransactionCodes-item-patch-request

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TransactionCodeId":{
            "title":"Transaction Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction code ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the transaction code for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that indicates if the transaction code is disabled for a warranty coverage..",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : assetWarrantyCoverages-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "CoverageEndDate":{
            "title":"Coverage End Date",
            "type":"string",
            "description":"Value that specifies the end date for a coverage.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Column that specifies the creation date of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ReactionsAndResolutions":{
            "title":"Reactions and Resolutions",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that indicates the reactions and resolutions documented by the warranty provider.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "coverageApplicabilities":{
            "title":"Coverage Applicabilities",
            "type":"array",
            "description":"The Coverage Applicabilities resource manages the applicabilities for a coverage.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyCoverages-coverageApplicabilities-item-response"
            }
        },
        "ManufacturerId":{
            "title":"Manufacturer ID",
            "type":"integer",
            "description":"Value that uniquely identifies the manufacturer.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageName":{
            "title":"Coverage Name",
            "maxLength":"120",
            "type":"string",
            "description":"Value that specifies the value of the coverage name.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageDescription":{
            "title":"Coverage Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that specifies the coverage description.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "AuthorizationRequiredFlag":{
            "title":"Requires Repair Authorization",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates whether an explicit authorization is to be sought before repair work is performed.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "FilterByTxnCodeFlag":{
            "title":"Filter by Transaction Code",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value that indicates if warranty contracts created using the warranty coverage can be filtered by their transaction codes when referenced in a warranty claim.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "coverageTransactionCodes":{
            "title":"Coverage Transaction Codes",
            "type":"array",
            "description":"The Coverage Transaction Codes resource manages transaction codes for a coverage.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyCoverages-coverageTransactionCodes-item-response"
            }
        },
        "PartsReturnRequiredFlag":{
            "title":"Parts Return Required",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating whether the original part must be returned to the provider.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"Primary key for the asset warranty coverage business object. The application creates this value. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoverageType":{
            "title":"Coverage Type",
            "maxLength":"255",
            "type":"string",
            "description":"Coverage type description of the warranty coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "InternalRepairAllowedFlag":{
            "title":"Allows Internal Repair",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating that the  coverage allows work to be performed by the consumer.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Column that identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageTypeCode":{
            "title":"Coverage Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the coverage type code attribute.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageStatus":{
            "title":"Coverage Status",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation for the status of the warranty coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManufacturerName":{
            "title":"Manufacturer Name",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the manufacturer name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Column that specifies the creator of the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageCode":{
            "title":"Coverage Code",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the coverage.",
            "nullable":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TermsAndConditions":{
            "title":"Terms and Conditions",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the terms and conditions of the coverage.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation for the unit of measure description for the warranty duration.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LaborReimbursementFlag":{
            "title":"Labor Reimbursement",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating whether the labor cost charged toward the repair work can be reimbursed to the provider.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "PartsReimbursementFlag":{
            "title":"Parts Reimbursement",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating whether the replacement cost for parts can be reimbursed to the provider.",
            "nullable":true,
            "default":false,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WarrantyProviderName":{
            "title":"Warranty Provider Name",
            "maxLength":"360",
            "type":"string",
            "description":"Value that identifies the warranty provider name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the supplier number.",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the warranty provider number.",
            "nullable":true,
            "x-queryable":true
        },
        "ContractsCreatedFlag":{
            "title":"Contracts Created",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that indicates if warranty contracts have been created based on the warranty coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":"360",
            "type":"string",
            "description":"Value that identifies the supplier name.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageStatusCode":{
            "title":"Coverage Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the coverage status code attribute.",
            "nullable":true,
            "default":"ORA_DRAFT",
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ManufacturerNumber":{
            "title":"Manufacturer Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the manufacturer number that provides the warranty coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyDuration":{
            "title":"Warranty Duration",
            "type":"number",
            "description":"Value that identifies the duration of the warranty. All warranties instantiated from this coverage will inherit this duration.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageStartDate":{
            "title":"Coverage Start Date",
            "type":"string",
            "description":"Value that specifies the coverage start date.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ServiceLevelAgreements":{
            "title":"Service-Level Agreements",
            "maxLength":"4000",
            "type":"string",
            "description":"Value that specifies the service level agreements with the warranty provider.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "WarrantyProviderId":{
            "title":"Warranty Provider ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Column that identifies the date and time of the last update on the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "coverageMeters":{
            "title":"Coverage  Meters",
            "type":"array",
            "description":"The Coverage Meters resource manages the coverage meter creation for a warranty.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyCoverages-coverageMeters-item-response"
            }
        }
    }
}

Nested Schema : Coverage Applicabilities

Type: array

Title: Coverage Applicabilities

The Coverage Applicabilities resource manages the applicabilities for a coverage.

Show Source

• Array of: object assetWarrantyCoverages-coverageApplicabilities-item-response

{
    "title":"Coverage Applicabilities",
    "type":"array",
    "description":"The Coverage Applicabilities resource manages the applicabilities for a coverage.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyCoverages-coverageApplicabilities-item-response"
    }
}

Nested Schema : Coverage Meters

Type: array

Title: Coverage Meters

The Coverage Meters resource manages the coverage meter creation for a warranty.

Show Source

• Array of: object assetWarrantyCoverages-coverageMeters-item-response

{
    "title":"Coverage  Meters",
    "type":"array",
    "description":"The Coverage Meters resource manages the coverage meter creation for a warranty.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyCoverages-coverageMeters-item-response"
    }
}

Nested Schema : Coverage Transaction Codes

Type: array

Title: Coverage Transaction Codes

The Coverage Transaction Codes resource manages transaction codes for a coverage.

Show Source

• Array of: object assetWarrantyCoverages-coverageTransactionCodes-item-response

{
    "title":"Coverage Transaction Codes",
    "type":"array",
    "description":"The Coverage Transaction Codes resource manages transaction codes for a coverage.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyCoverages-coverageTransactionCodes-item-response"
    }
}

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 : assetWarrantyCoverages-coverageApplicabilities-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Column that identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Column that identifies the date and time of creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ContractDefaultStatusCode":{
            "title":"Contract Default Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that specifies the default status code that can be assigned to the contract when the contract is auto created.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Column for identifying the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemOrganizationCode":{
            "title":"Item Organization Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the organization to which item is applicable for this coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ItemOrganizationName":{
            "title":"Item Organization Name",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the organization name to which the item is applicable for this coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractDefaultStatus":{
            "title":"Contract Default Status",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning for the Contract default status code that can be assigned to the contract when the contract is auto created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SupplierNumber":{
            "title":"Supplier Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the supplier number which is optionally used in matching the receipts for making the item applicable for the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AutoAssignFlag":{
            "title":"Autoassign",
            "maxLength":"1",
            "type":"boolean",
            "description":"Value indicating that the warranty can be automatically created and assigned to this coverage.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemDescription":{
            "title":"Item Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description for the item for which the coverage is applicable.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "title":"Item ID",
            "type":"integer",
            "description":"Value that identifies the item for which the coverage is applicable.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ItemLongDescription":{
            "title":"Long Description",
            "maxLength":"4000",
            "type":"string",
            "description":"Long description for the item for which the coverage is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemOrganizationId":{
            "title":"Item Organization ID",
            "type":"integer",
            "description":"Value that identifies the covered organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierId":{
            "title":"Supplier ID",
            "type":"integer",
            "description":"Value that uniquely identifies the supplier ID.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that specifies if the applicability is ineffective for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "ItemNumber":{
            "title":"Item Number",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the item number for which the coverage is applicable.",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageApplicabilityId":{
            "title":"Coverage Applicability ID",
            "type":"integer",
            "description":"Primary key for the coverage applicability business object.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "SupplierName":{
            "title":"Supplier Name",
            "maxLength":"360",
            "type":"string",
            "description":"Value that identifies the supplier name which is optionally used in matching the receipts for making the item applicable for the coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"Value that uniquely identifies the coverage to which the applicability belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Value that specifies the end date for the coverage applicability.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Column that identifies the date and time of the last update on the row.",
            "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."
        }
    }
}

Nested Schema : assetWarrantyCoverages-coverageMeters-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Column that identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Column that identifies the date and time of creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Column for identifying the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "UnitOfMeasure":{
            "title":"Unit of Measure",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation for the unit of measure description for the coverage meter.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MeterCode":{
            "title":"Meter Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value that identifies the meter code for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "MeterStartValue":{
            "title":"Meter Start Value",
            "type":"number",
            "description":"Value that identifies the meter start value attribute.",
            "nullable":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeterDescription":{
            "title":"Meter Description",
            "maxLength":"240",
            "type":"string",
            "description":"Value that identifies the meter description for the coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterDefinitionId":{
            "title":"Meter Definition ID",
            "type":"integer",
            "description":"Value that uniquely identifies the meter definition ID for the coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that identifies whether or not the meter is effective for the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageMeterId":{
            "title":"Coverage Meter ID",
            "type":"integer",
            "description":"Primary key for the coverage meter ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"Value that identifies the coverage ID to which the meter belongs.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "MeterName":{
            "title":"Meter Name",
            "maxLength":"120",
            "type":"string",
            "description":"Value that identifies the meter name for the coverage.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MeterIntervalValue":{
            "title":"Meter Interval Value",
            "type":"number",
            "description":"Value that identifies the meter interval value attribute.",
            "nullable":true,
            "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":"Value that identifies the UOM code for the meter associated with the coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Value that identifies the date on which the meter for the coverage becomes ineffective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Column that identifies the date and time of the last update on the row.",
            "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 : assetWarrantyCoverages-coverageTransactionCodes-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "TransactionCodeName":{
            "title":"Transaction Code Name",
            "maxLength":"240",
            "type":"string",
            "description":"Value that  identifies name of the transaction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Column that identifies the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TransactionCodeId":{
            "title":"Transaction Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the transaction code ID.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TransactionCodeDescription":{
            "title":"Transaction Code Description",
            "maxLength":"540",
            "type":"string",
            "description":"Value that  identifies the description of the transaction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Column that identifies the date and time of creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TransactionType":{
            "title":"Transaction Type",
            "maxLength":"80",
            "type":"string",
            "description":"Value that identifies the meaning of the transaction code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Column for identifying the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "DisabledFlag":{
            "title":"Disabled Indicator",
            "maxLength":"80",
            "type":"boolean",
            "description":"Value that indicates if the transaction code is disabled for a warranty coverage..",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageId":{
            "title":"Coverage ID",
            "type":"integer",
            "description":"Value that uniquely identifies the coverage ID to which the transaction code belong.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "TransactionTypeCode":{
            "title":"Transaction Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Value that uniquely identifies type of the transaction code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies the transaction code for the coverage.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoverageTransactionCodeId":{
            "title":"Coverage Transaction Code ID",
            "type":"integer",
            "description":"Value that uniquely identifies the coverage transaction code ID.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Value that identifies the date when the transaction code for the coverage becomes ineffective.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"Column that identifies the date and time of the last update on the row.",
            "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"
    }
}

Links

coverageApplicabilities

Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageApplicabilities

Parameters:

• CoverageId: $request.path.CoverageId

The Coverage Applicabilities resource manages the applicabilities for a coverage.

coverageMeters

Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageMeters

Parameters:

• CoverageId: $request.path.CoverageId

The Coverage Meters resource manages the coverage meter creation for a warranty.

coverageTransactionCodes

Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageTransactionCodes

Parameters:

• CoverageId: $request.path.CoverageId

The Coverage Transaction Codes resource manages transaction codes for a coverage.

Back to Top

Examples

This example describes how to update a warranty coverage.

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/assetWarrantyCoverages/CoverageId"

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.

{
"CoverageStartDate": "2022-02-01"
}

Example 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-02-01",
    "CoverageEndDate": "2023-12-31",
    "CoverageStatusCode": "ORA_READY",
    "CoverageStatus": "Ready",
    "CoverageTypeCode": null,
    "CoverageType": null,
    "ManufacturerId": 300100120329772,
    "ManufacturerNumber": "123456",
    "ManufacturerName": "Manufacturer1",
    "SupplierId": 999992000322154,
    "SupplierNumber": "654321",
    "SupplierName": "Supplier1",
    "WarrantyProviderId": 999992000322153,
    "WarrantyProviderNumber": "12345678",
    "WarrantyProviderName": "Provider1",
    "WarrantyDuration": 30,
    "UOMCode": "ORA_DAY",
    "UnitOfMeasure": "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,
    "ContractsCreatedFlag": false,
    "CreatedBy": "USER",
    "CreationDate": "2022-10-28T13:53:35+00:00",
    "LastUpdatedBy": "USER",
    "LastUpdateDate": "2022-10-28T13:53:35.001+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739",
            "name": "assetWarrantyCoverages",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739",
            "name": "assetWarrantyCoverages",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities",
            "name": "coverageApplicabilities",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageMeters",
            "name": "coverageMeters",
            "kind": "collection"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes",
            "name": "coverageTransactionCodes",
            "kind": "collection"
        }
    ]
}

Back to Top