1. REST API for Oracle Fusion Cloud SCM
  2. Tasks
  3. Maintenance
  4. Asset Warranty Contracts

Create

post

/fscmRestApi/resources/11.13.18.05/assetWarrantyContracts

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 : Contract Meters
Type: array
Title: Contract Meters
Show Source
Nested Schema : schema
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 : assetWarrantyContracts-item-response
Type: object
Show Source
Nested Schema : Contract Meters
Type: array
Title: Contract Meters
Show Source
Nested Schema : assetWarrantyContracts-contractMeters-item-response
Type: object
Show Source
Links
contractMeters
Parameters:
  • ContractId: $request.path.ContractId
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://servername/fscmRestApi/resources/version/assetWarrantyContracts"

Example 1

This example describes how to create a warranty contract using a number reference for the asset and a code reference for the warranty coverage. 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. 

{
"ObjectTypeCode": "ORA_ASSET",
"AssetNumber": "ALM_ASSET_001",
"CoverageCode": "ALM_COVERAGE",
"ContractStartDate": "2022-10-01"
}

Example 1 Response Body

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

{
    "ContractId": 300100568130806,
    "ContractNumber": "300100568130806",
    "CoverageId": 300100568130805,
    "CoverageName": null,
    "CoverageCode": "ALM_COVERAGE",
    "CoverageDescription": null,
    "WarrantyProviderNumber": null,
    "WarrantyProviderName": null,
    "ObjectId": 300100566813034,
    "ObjectTypeCode": "ORA_ASSET",
    "ObjectType": null,
    "AssetNumber": "ALM_ASSET_001",
    "AssetSerialNumber": null,
    "ContractStatusCode": "ORA_READY",
    "ContractStatus": null,
    "ContractStartDate": "2022-10-01",
    "ContractEndDate": "2022-10-31",
    "CalculatedExpirationDate": null,
    "ExternalReferenceNumber": null,
    "ContractNotes": null,
    "CreatedBy": "USER",
    "CreationDate": "2022-10-28T15:42:12+00:00",
    "LastUpdateDate": "2022-10-28T15:42:12.001+00:00",
    "LastUpdatedBy": "USER",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806",
            "name": "assetWarrantyContracts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806",
            "name": "assetWarrantyContracts",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806/child/contractMeters",
            "name": "contractMeters",
            "kind": "collection"
        }
    ]
}

Example 2

This example describes how to create a warranty contract using ID references for the asset object and warranty coverage. 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. 

{
"ObjectTypeCode": "ORA_ASSET",
"ObjectId": 300100566813034,
"CoverageId": 300100568130807,
"ContractStartDate": "2022-10-01"
}

Example 2 Response Body

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

{
    "ContractId": 300100568130904,
    "ContractNumber": "300100568130904",
    "CoverageId": 300100568130807,
    "CoverageName": null,
    "CoverageCode": null,
    "CoverageDescription": null,
    "WarrantyProviderNumber": null,
    "WarrantyProviderName": null,
    "ObjectId": 300100566813034,
    "ObjectTypeCode": "ORA_ASSET",
    "ObjectType": null,
    "AssetNumber": null,
    "AssetSerialNumber": null,
    "ContractStatusCode": "ORA_READY",
    "ContractStatus": null,
    "ContractStartDate": "2022-10-01",
    "ContractEndDate": "2022-10-31",
    "CalculatedExpirationDate": null,
    "ExternalReferenceNumber": null,
    "ContractNotes": null,
    "CreatedBy": "USER",
    "CreationDate": "2022-10-28T15:42:12+00:00",
    "LastUpdateDate": "2022-10-28T15:42:12.001+00:00",
    "LastUpdatedBy": "USER",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806",
            "name": "assetWarrantyContracts",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806",
            "name": "assetWarrantyContracts",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130806/child/contractMeters",
            "name": "contractMeters",
            "kind": "collection"
        }
    ]
}
Back to Top