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

Get one contract

get

/fscmRestApi/resources/11.13.18.05/assetWarrantyContracts/{ContractId}

Request

Path Parameters
Query Parameters
  • This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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.

There's no request body for this operation.

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
  • Read Only: true
    Value that uniquely identifies an asset.
  • Title: Asset Number
    Maximum Length: 80
    Number that uniquely identifies an asset.
  • Title: Asset Serial Number
    Read Only: true
    Maximum Length: 80
    Serial number of an asset.
  • Title: Contract Calculated Expiration Date
    Calculated expiration date of the warranty contract. This attribute is the latest expiration date among the contract meters.
  • Title: Contract End Date
    End Date of the warranty contract.
  • Title: Contract ID
    Read Only: true
    Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
  • Contract Meters
    Title: Contract Meters
    The Contract Meters resource manages the asset meters for the contract. You can add, remove, and view the list of the asset meters.
  • Title: Contract Notes
    Maximum Length: 2000
    Notes of the warranty contract.
  • Title: Contract Number
    Maximum Length: 80
    Number that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
  • Title: Contract Start Date
    Start Date of the warranty contract. This attribute is required.
  • Title: Contract Status Code Description
    Read Only: true
    Maximum Length: 80
    Name of the status for the warranty coverage.
  • Title: Contract Status Code
    Maximum Length: 30
    Default Value: ORA_READY
    Status of the warranty contract. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CONTRACT_STATUS. This attribute is required to create the coverage.
  • Title: Coverage Code
    Maximum Length: 80
    Abbreviation that uniquely identifies the warranty coverage. This attribute is required to create the warranty contract.
  • Title: Coverage Description
    Read Only: true
    Maximum Length: 240
    Description of the warranty coverage.
  • Title: Coverage ID
    Value that uniquely identifies the warranty coverage.
  • Title: Coverage Name
    Read Only: true
    Maximum Length: 120
    Name of the warranty coverage.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Login username of the user who created the record.
  • Title: Creation Date
    Read Only: true
    Date when the record was created.
  • Title: Contract External Reference Number
    Maximum Length: 80
    Number of an external reference to the warranty contract. This attribute is optinal.
  • Title: Last Update Date
    Read Only: true
    Date when the record was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login username of the user who updated the record.
  • Links
  • Title: Object ID
    Value that uniquely identifies the object in a warranty contract. This attribute is required.
  • Title: Object Type
    Read Only: true
    Maximum Length: 80
    Name of the object type code.
  • Title: Object Type Code
    Maximum Length: 30
    Abbreviation that uniquely identifies the type of object for the warranty contract. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CONTRACT_OBJECT. This attribute is required.
  • Read Only: true
    Value that uniquely identifies the root asset.
  • Read Only: true
    Maximum Length: 80
    Number that uniquely identifies the root asset.
  • Title: Warranty Provider Name
    Read Only: true
    Maximum Length: 360
    Value that identifies the warranty provider name attribute for the contracts.
  • Title: Warranty Provider Number
    Read Only: true
    Maximum Length: 30
    Value that identifies the warranty provider number attribute for the contracts.
Nested Schema : Contract Meters
Type: array
Title: Contract Meters
The Contract Meters resource manages the asset meters for the contract. You can add, remove, and view the list of the asset meters.
Show Source
Nested Schema : assetWarrantyContracts-contractMeters-item-response
Type: object
Show Source
  • Title: Active End Date
    Read Only: true
    Date that indicates if a meter definition is disabled for a warranty contract.
  • Title: Calculated End Date
    Read Only: true
    The calculated contract due date value in a warranty contract.
  • Read Only: true
    Value that uniquely identifies the warranty contract. The application creates this value when it creates the contract.
  • Title: Contract Meter ID
    Read Only: true
    Value that uniquely identifies the warranty contract meter. The application creates this value when it creates the contract meter.
  • Title: Created By
    Read Only: true
    Maximum Length: 64
    Login user name of the user who created the record.
  • Title: Creation Date
    Read Only: true
    Date when the record was created.
  • Title: Disabled Indicator
    Maximum Length: 80
    Flag that is used to set the active end date of the contract meters.Valid values are Y and N.
  • Title: Last Update Date
    Read Only: true
    Date when the record was updated.
  • Title: Last Updated By
    Read Only: true
    Maximum Length: 64
    Login user name of the user who updated the record.
  • Links
  • Title: Meter Code
    Maximum Length: 30
    Abbreviation that uniquely identifies a meter definition in a warranty contract.
  • Title: Meter Description
    Read Only: true
    Maximum Length: 240
    The description of a meter definition.
  • Title: Meter End Value
    Read Only: true
    End value for a meter in a warranty contract.
  • Title: Meter ID
    Value that uniquely identifies the meter definition in a warranty contract. The meter must be active for the asset number referenced in the contract.
  • Title: Meter Interval Value
    The interval value for a meter in a warranty contract.
  • Title: Contract Meter Name
    Read Only: true
    Maximum Length: 120
    The name of a meter definition.
  • Title: Meter Start Value
    The start value for a meter in a warranty contract.
  • Title: Unit of Measure
    Read Only: true
    Maximum Length: 25
    Name of the unit of measure for the warranty.
  • Title: Unit of Measure Code
    Read Only: true
    Maximum Length: 3
    Abbreviation that uniquely identifies the unit of measure for the meter. A list of accepted values is defined in the lookup type TBD. This attribute is required if the Duration is defined, else it is optional.
Links
contractMeters
Parameters:
  • ContractId: $request.path.ContractId
The Contract Meters resource manages the asset meters for the contract. You can add, remove, and view the list of the asset meters.
Back to Top

Examples

This example describes how to get one warranty contract.

Example cURL Command

Use the following cURL command to submit a request on the REST resource:

curl -u username:password "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/ContractId"

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "ContractId": 300100568130806,
    "ContractNumber": "300100568130806",
    "CoverageId": 300100568130805,
    "CoverageName": "ALM Coverage Dur Only",
    "CoverageCode": "ALM_COVERAGE_D",
    "CoverageDescription": "ALM COVERAGE Duration Only",
    "WarrantyProviderNumber": "654231",
    "WarrantyProviderName": "Provider2",
    "ObjectId": 300100566813034,
    "ObjectTypeCode": "ORA_ASSET",
    "ObjectType": "Asset",
    "AssetNumber": "ALM_ASSET_001",
    "AssetSerialNumber": null,
    "ContractStatusCode": "ORA_READY",
    "ContractStatus": "Ready",
    "ContractStartDate": "2022-10-01",
    "ContractEndDate": "2022-10-31",
    "CalculatedExpirationDate": null,
    "ExternalReferenceNumber": null,
    "ContractNotes": null,
    "CreatedBy": "USER",
    "CreationDate": "2022-10-28T15:46:26+00:00",
    "LastUpdateDate": "2022-10-28T15:46:26.001+00:00",
    "LastUpdatedBy": "USER",
    "links": [
               {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904",
                    "name": "assetWarrantyContracts",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904",
                    "name": "assetWarrantyContracts",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyContracts/300100568130904/child/contractMeters",
                    "name": "contractMeters",
                    "kind": "collection"
                }
            ]
}
Back to Top