Create
/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages
Request
-
Metadata-Context: string
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: string
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
- application/json
object-
AuthorizationRequiredFlag: boolean
Title:
Requires Repair AuthorizationMaximum Length:1Default Value:false -
coverageApplicabilities: array
Coverage Applicabilities
Title:
Coverage Applicabilities -
CoverageCode(required): string
Title:
Coverage CodeMaximum Length:80 -
CoverageDescription: string
Title:
Coverage DescriptionMaximum Length:240 -
CoverageEndDate: string
(date)
Title:
Coverage End Date -
coverageMeters: array
Coverage Meters
Title:
Coverage Meters -
CoverageName(required): string
Title:
Coverage NameMaximum Length:120 -
CoverageStartDate: string
(date)
Title:
Coverage Start Date -
CoverageStatusCode: string
Title:
Coverage Status CodeMaximum Length:30Default Value:ORA_DRAFT -
coverageTransactionCodes: array
Coverage Transaction Codes
Title:
Coverage Transaction Codes -
CoverageTypeCode: string
Title:
Coverage Type CodeMaximum Length:30 -
FilterByTxnCodeFlag: boolean
Title:
Filter by Transaction CodeMaximum Length:1Default Value:false -
InternalRepairAllowedFlag: boolean
Title:
Allows Internal RepairMaximum Length:1Default Value:false -
LaborReimbursementFlag: boolean
Title:
Labor ReimbursementMaximum Length:1Default Value:false -
ManufacturerId: integer
(int64)
Title:
Manufacturer ID -
ManufacturerNumber: string
Title:
Manufacturer NumberMaximum Length:255 -
PartsReimbursementFlag: boolean
Title:
Parts ReimbursementMaximum Length:1Default Value:false -
PartsReturnRequiredFlag: boolean
Title:
Parts Return RequiredMaximum Length:1Default Value:false -
ReactionsAndResolutions: string
Title:
Reactions and ResolutionsMaximum Length:4000 -
ServiceLevelAgreements: string
Title:
Service-Level AgreementsMaximum Length:4000 -
SupplierId: integer
(int64)
Title:
Supplier ID -
SupplierNumber: string
Title:
Supplier NumberMaximum Length:255 -
TermsAndConditions: string
Title:
Terms and ConditionsMaximum Length:4000 -
UOMCode: string
Title:
Unit of Measure CodeMaximum Length:30 -
WarrantyDuration: number
Title:
Warranty Duration -
WarrantyProviderId(required): integer
(int64)
Title:
Warranty Provider ID -
WarrantyProviderNumber: string
Title:
Warranty Provider NumberMaximum Length:255
arrayCoverage Transaction Codesobject-
AutoAssignFlag: boolean
Title:
AutoassignMaximum Length:1Default Value:true -
ContractDefaultStatusCode: string
Title:
Contract Default Status CodeMaximum Length:30 -
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
ItemId: integer
(int64)
Title:
Item ID -
ItemNumber: string
Title:
Item NumberMaximum Length:255 -
ItemOrganizationCode: string
Title:
Item Organization CodeMaximum Length:255 -
ItemOrganizationId: integer
(int64)
Title:
Item Organization ID -
SupplierId: integer
(int64)
Title:
Supplier ID -
SupplierNumber: string
Title:
Supplier NumberMaximum Length:255
object-
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
MeterCode: string
Title:
Meter CodeMaximum Length:255 -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition ID -
MeterIntervalValue: number
Title:
Meter Interval Value -
MeterStartValue: number
Title:
Meter Start Value
object-
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
TransactionCode: string
Title:
Transaction CodeMaximum Length:255 -
TransactionCodeId: integer
(int64)
Title:
Transaction Code ID
Response
- application/json
Default Response
-
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.
object-
AuthorizationRequiredFlag: boolean
Title:
Requires Repair AuthorizationMaximum Length:1Default Value:false -
ContractsCreatedFlag: boolean
Title:
Contracts CreatedRead Only:trueMaximum Length:80 -
coverageApplicabilities: array
Coverage Applicabilities
Title:
Coverage Applicabilities -
CoverageCode: string
Title:
Coverage CodeMaximum Length:80 -
CoverageDescription: string
Title:
Coverage DescriptionMaximum Length:240 -
CoverageEndDate: string
(date)
Title:
Coverage End Date -
CoverageId: integer
(int64)
Title:
Coverage IDRead Only:true -
coverageMeters: array
Coverage Meters
Title:
Coverage Meters -
CoverageName: string
Title:
Coverage NameMaximum Length:120 -
CoverageStartDate: string
(date)
Title:
Coverage Start Date -
CoverageStatus: string
Title:
Coverage StatusRead Only:trueMaximum Length:80 -
CoverageStatusCode: string
Title:
Coverage Status CodeMaximum Length:30Default Value:ORA_DRAFT -
coverageTransactionCodes: array
Coverage Transaction Codes
Title:
Coverage Transaction Codes -
CoverageType: string
Title:
Coverage TypeRead Only:trueMaximum Length:255 -
CoverageTypeCode: string
Title:
Coverage Type CodeMaximum Length:30 -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
FilterByTxnCodeFlag: boolean
Title:
Filter by Transaction CodeMaximum Length:1Default Value:false -
InternalRepairAllowedFlag: boolean
Title:
Allows Internal RepairMaximum Length:1Default Value:false -
LaborReimbursementFlag: boolean
Title:
Labor ReimbursementMaximum Length:1Default Value:false -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ManufacturerId: integer
(int64)
Title:
Manufacturer ID -
ManufacturerName: string
Title:
Manufacturer NameRead Only:trueMaximum Length:255 -
ManufacturerNumber: string
Title:
Manufacturer NumberMaximum Length:255 -
PartsReimbursementFlag: boolean
Title:
Parts ReimbursementMaximum Length:1Default Value:false -
PartsReturnRequiredFlag: boolean
Title:
Parts Return RequiredMaximum Length:1Default Value:false -
ReactionsAndResolutions: string
Title:
Reactions and ResolutionsMaximum Length:4000 -
ServiceLevelAgreements: string
Title:
Service-Level AgreementsMaximum Length:4000 -
SupplierId: integer
(int64)
Title:
Supplier ID -
SupplierName: string
Title:
Supplier NameRead Only:trueMaximum Length:360 -
SupplierNumber: string
Title:
Supplier NumberMaximum Length:255 -
TermsAndConditions: string
Title:
Terms and ConditionsMaximum Length:4000 -
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:80 -
UOMCode: string
Title:
Unit of Measure CodeMaximum Length:30 -
WarrantyDuration: number
Title:
Warranty Duration -
WarrantyProviderId: integer
(int64)
Title:
Warranty Provider ID -
WarrantyProviderName: string
Title:
Warranty Provider NameRead Only:trueMaximum Length:360 -
WarrantyProviderNumber: string
Title:
Warranty Provider NumberMaximum Length:255
arrayCoverage Transaction CodesarrayLinksobject-
ActiveEndDate: string
(date)
Title:
Active End DateRead Only:true -
AutoAssignFlag: boolean
Title:
AutoassignMaximum Length:1Default Value:true -
ContractDefaultStatus: string
Title:
Contract Default StatusRead Only:trueMaximum Length:80 -
ContractDefaultStatusCode: string
Title:
Contract Default Status CodeMaximum Length:30 -
CoverageApplicabilityId: integer
(int64)
Title:
Coverage Applicability IDRead Only:true -
CoverageId: integer
(int64)
Title:
Coverage IDRead Only:true -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
ItemDescription: string
Title:
Item DescriptionRead Only:trueMaximum Length:240 -
ItemId: integer
(int64)
Title:
Item ID -
ItemLongDescription: string
Title:
Long DescriptionRead Only:trueMaximum Length:4000 -
ItemNumber: string
Title:
Item NumberMaximum Length:255 -
ItemOrganizationCode: string
Title:
Item Organization CodeMaximum Length:255 -
ItemOrganizationId: integer
(int64)
Title:
Item Organization ID -
ItemOrganizationName: string
Title:
Item Organization NameRead Only:trueMaximum Length:255 -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
SupplierId: integer
(int64)
Title:
Supplier ID -
SupplierName: string
Title:
Supplier NameRead Only:trueMaximum Length:360 -
SupplierNumber: string
Title:
Supplier NumberMaximum Length:255
arrayLinksobject-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]The name of the relation to the resource instance. Example: self.
object-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
object-
ActiveEndDate: string
(date)
Title:
Active End DateRead Only:true -
CoverageId: integer
(int64)
Title:
Coverage IDRead Only:true -
CoverageMeterId: integer
(int64)
Title:
Coverage Meter IDRead Only:true -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MeterCode: string
Title:
Meter CodeMaximum Length:255 -
MeterDefinitionId: integer
(int64)
Title:
Meter Definition ID -
MeterDescription: string
Title:
Meter DescriptionRead Only:trueMaximum Length:240 -
MeterIntervalValue: number
Title:
Meter Interval Value -
MeterName: string
Title:
Meter NameRead Only:trueMaximum Length:120 -
MeterStartValue: number
Title:
Meter Start Value -
UnitOfMeasure: string
Title:
Unit of MeasureRead Only:trueMaximum Length:255 -
UOMCode: string
Title:
Unit of Measure CodeRead Only:trueMaximum Length:3
arrayLinksobject-
ActiveEndDate: string
(date)
Title:
Active End DateRead Only:true -
CoverageId: integer
(int64)
Title:
Coverage IDRead Only:true -
CoverageTransactionCodeId: integer
(int64)
Title:
Coverage Transaction Code IDRead Only:true -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64 -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:true -
DisabledFlag: boolean
Title:
Disabled IndicatorMaximum Length:80 -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:true -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64 -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
TransactionCode: string
Title:
Transaction CodeMaximum Length:255 -
TransactionCodeDescription: string
Title:
Transaction Code DescriptionRead Only:trueMaximum Length:540 -
TransactionCodeId: integer
(int64)
Title:
Transaction Code ID -
TransactionCodeName: string
Title:
Transaction Code NameRead Only:trueMaximum Length:240 -
TransactionType: string
Title:
Transaction TypeRead Only:trueMaximum Length:80 -
TransactionTypeCode: string
Title:
Transaction Type CodeRead Only:trueMaximum Length:30
arrayLinks- coverageApplicabilities
-
Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageApplicabilitiesParameters:
- CoverageId:
$request.path.CoverageId
- CoverageId:
- coverageMeters
-
Operation: /fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageMetersParameters:
- CoverageId:
$request.path.CoverageId
- CoverageId:
- coverageTransactionCodes
-
Parameters:
- CoverageId:
$request.path.CoverageId
- CoverageId:
Examples
Example cURL Command
Use the following cURL command to submit a request on the REST resource.
curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages"
Example 1
This example describes how to create a warranty coverage using number references for the provider, manufacturer and supplier. For additional examples, see the Create and Update Supplier Warranty use case.
Example 1 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"CoverageName": "ALM Coverage",
"CoverageCode": "ALM_COVERAGE",
"CoverageDescription": "ALM COVERAGE DESCRIPTION",
"CoverageStartDate": "2022-01-01",
"CoverageEndDate": "2022-12-31",
"CoverageStatusCode": "ORA_READY",
"CoverageTypeCode": "5YRWTY",
"ManufacturerNumber": "123456",
"SupplierNumber": "654321",
"WarrantyProviderNumber": "123456",
"WarrantyDuration": 30,
"UOMCode": "ORA_DAY",
"TermsAndConditions": "Defined terms and conditions",
"ReactionsAndResolutions": "Defined reactions and resolutions",
"ServiceLevelAgreements": "Defined service level agreements",
"InternalRepairAllowedFlag": true,
"AuthorizationRequiredFlag": true,
"PartsReimbursementFlag": true,
"PartsReturnRequiredFlag": true,
"LaborReimbursementFlag": true,
"FilterByTxnCodeFlag": true
}
Example 1 Response Body
The following example includes the contents of the response body in JSON format:
{
"CoverageId": 300100568130739,
"CoverageName": "ALM Coverage",
"CoverageCode": "ALM_COVERAGE",
"CoverageDescription": "ALM COVERAGEDESCRIPTION",
"CoverageStartDate": "2022-01-01",
"CoverageEndDate": "2023-12-31",
"CoverageStatusCode": "ORA_READY",
"CoverageStatus": null,
"CoverageTypeCode": "NEWWTY",
"CoverageType": null,
"ManufacturerId": 300100120329772,
"ManufacturerNumber": "123456",
"ManufacturerName": null,
"SupplierId": 999992000322154,
"SupplierNumber": "654321",
"SupplierName": null,
"WarrantyProviderId": 999992000322153,
"WarrantyProviderNumber": "12345678",
"WarrantyProviderName": null,
"WarrantyDuration": 30,
"UOMCode": "ORA_DAY",
"UnitOfMeasure": null,
"TermsAndConditions": "Defined terms and conditions",
"ReactionsAndResolutions": "Defined reactions and resolutions",
"ServiceLevelAgreements": "Defined service level agreements",
"InternalRepairAllowedFlag": true,
"AuthorizationRequiredFlag": true,
"PartsReimbursementFlag": true,
"PartsReturnRequiredFlag": true,
"LaborReimbursementFlag": true,
"FilterByTxnCodeFlag": true,
"ContractsCreatedFlag": false,
"CreatedBy": "USER",
"CreationDate": "2022-01-01T13:53:35+00:00",
"LastUpdatedBy": "USER",
"LastUpdateDate": "2022-01-01T13:53:35.001+00:00",
"links": [
{
"rel": "self",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739",
"name": "assetWarrantyCoverages",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739",
"name": "assetWarrantyCoverages",
"kind": "item"
},
{
"rel": "child",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities",
"name": "coverageApplicabilities",
"kind": "collection"
},
{
"rel": "child",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageMeters",
"name": "coverageMeters",
"kind": "collection"
},
{
"rel": "child",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes",
"name": "coverageTransactionCodes",
"kind": "collection"
}
]
}
Example 2
This example describes how to create a warranty coverage using ID references for the provider, manufacturer, and supplier. For additional examples, see the Create and Update Supplier Warranty use case.
Example 2 Request Body
The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.
{
"CoverageName": "ALM Coverage",
"CoverageCode": "ALM_COVERAGE",
"CoverageDescription": "ALM COVERAGE DESCRIPTION",
"CoverageStartDate": "2022-01-01",
"CoverageEndDate": "2022-12-31",
"CoverageStatusCode": "ORA_DRAFT",
"CoverageTypeCode": "5YRWTY",
"WarrantyProviderId": "999992000322153",
"SupplierId": "999992000322154",
"ManufacturerId": "300100120329772",
"WarrantyDuration": 30,
"UOMCode": "ORA_DAY",
"TermsAndConditions": "Defined terms and conditions",
"ReactionsAndResolutions": "Defined reactions and resolutions",
"ServiceLevelAgreements": "Defined service level agreements",
"InternalRepairAllowedFlag": true,
"AuthorizationRequiredFlag": true,
"PartsReimbursementFlag": true,
"PartsReturnRequiredFlag": true,
"LaborReimbursementFlag": true,
"FilterByTxnCodeFlag": true
}
Example 2 Response Body
The following example includes the contents of the response body in JSON format:
{
"CoverageId": 300100568130739,
"CoverageName": "ALM Coverage",
"CoverageCode": "ALM_COVERAGE",
"CoverageDescription": "ALM COVERAGEDESCRIPTION",
"CoverageStartDate": "2022-01-01",
"CoverageEndDate": "2023-12-31",
"CoverageStatusCode": "ORA_READY",
"CoverageStatus": null,
"CoverageTypeCode": "NEWWTY",
"CoverageType": null,
"ManufacturerId": 300100120329772,
"ManufacturerNumber": "123456",
"ManufacturerName": null,
"SupplierId": 999992000322154,
"SupplierNumber": "654321",
"SupplierName": null,
"WarrantyProviderId": 999992000322153,
"WarrantyProviderNumber": "12345678",
"WarrantyProviderName": null,
"WarrantyDuration": 30,
"UOMCode": "ORA_DAY",
"UnitOfMeasure": null,
"TermsAndConditions": "Defined terms and conditions",
"ReactionsAndResolutions": "Defined reactions and resolutions",
"ServiceLevelAgreements": "Defined service level agreements",
"InternalRepairAllowedFlag": true,
"AuthorizationRequiredFlag": true,
"PartsReimbursementFlag": true,
"PartsReturnRequiredFlag": true,
"LaborReimbursementFlag": true,
"FilterByTxnCodeFlag": true,
"ContractsCreatedFlag": false,
"CreatedBy": "USER",
"CreationDate": "2022-01-01T13:53:35+00:00",
"LastUpdatedBy": "USER",
"LastUpdateDate": "2022-01-01T13:53:35.001+00:00",
"links": [
{
"rel": "self",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739",
"name": "assetWarrantyCoverages",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
}
},
{
"rel": "canonical",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739",
"name": "assetWarrantyCoverages",
"kind": "item"
},
{
"rel": "child",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities",
"name": "coverageApplicabilities",
"kind": "collection"
},
{
"rel": "child",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageMeters",
"name": "coverageMeters",
"kind": "collection"
},
{
"rel": "child",
"href": "https://<varname>servername</varname>/fscmRestApi/resources/<varname>version</varname>/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes",
"name": "coverageTransactionCodes",
"kind": "collection"
}
]
}