Create warranty coverages

post

/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages

Request

Header Parameters
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Coverage Applicabilities
Type: array
Title: Coverage Applicabilities
The Coverage Applicabilities resource manages the applicabilities for a coverage.
Show Source
Nested Schema : Coverage Meters
Type: array
Title: Coverage Meters
The Coverage Meters resource manages the coverage meter creation for a warranty.
Show Source
Nested Schema : Coverage Transaction Codes
Type: array
Title: Coverage Transaction Codes
The Coverage Transaction Codes resource manages transaction codes for a coverage.
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Autoassign
    Maximum Length: 1
    Default Value: true
    Value indicating that the warranty can be automatically created and assigned to this coverage.
  • 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.
  • Title: Disabled Indicator
    Maximum Length: 80
    Value that specifies if the applicability is ineffective for the coverage.
  • Title: Item ID
    Value that identifies the item for which the coverage is applicable.
  • Title: Item Number
    Maximum Length: 255
    Value that identifies the item number for which the coverage is applicable.
  • Title: Item Organization Code
    Maximum Length: 255
    Value that identifies the organization to which item is applicable for this coverage.
  • Title: Item Organization ID
    Value that identifies the covered organization.
  • Title: Supplier ID
    Value that uniquely identifies the supplier ID.
  • 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.
Nested Schema : schema
Type: object
Show Source
Nested Schema : assetWarrantyCoverages-coverageTransactionCodes-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
  • The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Body ()
Root Schema : assetWarrantyCoverages-item-response
Type: object
Show Source
Nested Schema : Coverage Applicabilities
Type: array
Title: Coverage Applicabilities
The Coverage Applicabilities resource manages the applicabilities for a coverage.
Show Source
Nested Schema : Coverage Meters
Type: array
Title: Coverage Meters
The Coverage Meters resource manages the coverage meter creation for a warranty.
Show Source
Nested Schema : Coverage Transaction Codes
Type: array
Title: Coverage Transaction Codes
The Coverage Transaction Codes resource manages transaction codes for a coverage.
Show Source
Nested Schema : assetWarrantyCoverages-coverageApplicabilities-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Value that specifies the end date for the coverage applicability.
  • Title: Autoassign
    Maximum Length: 1
    Default Value: true
    Value indicating that the warranty can be automatically created and assigned to this coverage.
  • 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.
  • 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.
  • Title: Coverage Applicability ID
    Read Only: true
    Primary key for the coverage applicability business object.
  • Title: Coverage ID
    Read Only: true
    Value that uniquely identifies the coverage to which the applicability belongs.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Column for identifying the user who created the row.
  • Title: Creation Date
    Read Only: true
    Column that identifies the date and time of creation of the row.
  • Title: Disabled Indicator
    Maximum Length: 80
    Value that specifies if the applicability is ineffective for the coverage.
  • Title: Item Description
    Read Only: true
    Maximum Length: 240
    Description for the item for which the coverage is applicable.
  • Title: Item ID
    Value that identifies the item for which the coverage is applicable.
  • Title: Long Description
    Read Only: true
    Maximum Length: 4000
    Long description for the item for which the coverage is applicable.
  • Title: Item Number
    Maximum Length: 255
    Value that identifies the item number for which the coverage is applicable.
  • Title: Item Organization Code
    Maximum Length: 255
    Value that identifies the organization to which item is applicable for this coverage.
  • Title: Item Organization ID
    Value that identifies the covered organization.
  • 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.
  • Title: Last Update Date
    Read Only: true
    Column that identifies the date and time of the last update on the row.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Column that identifies the user who last updated the row.
  • Links
  • Title: Supplier ID
    Value that uniquely identifies the supplier ID.
  • 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.
  • 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.
Nested Schema : assetWarrantyCoverages-coverageMeters-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Value that identifies the date on which the meter for the coverage becomes ineffective.
  • Title: Coverage ID
    Read Only: true
    Value that identifies the coverage ID to which the meter belongs.
  • Title: Coverage Meter ID
    Read Only: true
    Primary key for the coverage meter ID.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Column for identifying the user who created the row.
  • Title: Creation Date
    Read Only: true
    Column that identifies the date and time of creation of the row.
  • Title: Disabled Indicator
    Maximum Length: 80
    Value that identifies whether or not the meter is effective for the coverage.
  • Title: Last Update Date
    Read Only: true
    Column that identifies the date and time of the last update on the row.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Column that identifies the user who last updated the row.
  • Links
  • Title: Meter Code
    Maximum Length: 255
    Value that identifies the meter code for the coverage.
  • Title: Meter Definition ID
    Value that uniquely identifies the meter definition ID for the coverage.
  • Title: Meter Description
    Read Only: true
    Maximum Length: 240
    Value that identifies the meter description for the coverage.
  • Title: Meter Interval Value
    Value that identifies the meter interval value attribute.
  • Title: Meter Name
    Read Only: true
    Maximum Length: 120
    Value that identifies the meter name for the coverage.
  • Title: Meter Start Value
    Value that identifies the meter start value attribute.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 255
    Abbreviation for the unit of measure description for the coverage meter.
  • Title: Unit of Measure Code
    Read Only: true
    Maximum Length: 3
    Value that identifies the UOM code for the meter associated with the coverage.
Nested Schema : assetWarrantyCoverages-coverageTransactionCodes-item-response
Type: object
Show Source
Back to Top

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"
        }
    ]
}
Back to Top