Create one coverage applicability
/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageApplicabilities
Request
-
CoverageId(required): integer(int64)
Primary key for the asset warranty coverage business object. The application creates this value. This attribute is read-only.
-
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.
-
Upsert-Mode:
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
-
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.
Response
- application/json
Default Response
-
Metadata-Context(required):
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(required):
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
-
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.
array
Links
object
-
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.
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
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/assetWarrantyCoverages/CoverageId/child/coverageApplicabilities"
Example 1
This example describes how to create a coverage applicability item and suppplier for a warranty coverage using a number reference for the item and supplier. For additional examples, see the Create and Update Supplier Warranty use case.
Example 1 Request Body
{ "ItemNumber": "ALM-MX-ITEM-001", "ItemOrganizationCode": "ORG1", "SupplierNumber": "654321", "AutoAssignFlag": true, "ContractDefaultStatusCode": "ORA_READY" }
Example 1 Response Body
{ "CoverageApplicabilityId": 300100568130763, "CoverageId": 300100568130739, "ItemId": 300100566813001, "ItemNumber": "ALM-MX-ITEM-001", "ItemDescription": null, "ItemLongDescription": null, "ItemOrganizationId": 300100113363336, "ItemOrganizationCode": "MNTALM", "ItemOrganizationName": null, "SupplierId": 999992000322153, "SupplierNumber": "654321", "SupplierName": null, "AutoAssignFlag": false, "ContractDefaultStatusCode": "ORA_DRAFT", "ContractDefaultStatus": null, "DisabledFlag": false, "ActiveEndDate": null, "CreatedBy": "USER", "CreationDate": "2022-10-28T14:48:10+00:00", "LastUpdatedBy": "USER", "LastUpdateDate": "2022-10-28T14:48:10.001+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763", "name": "coverageApplicabilities", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763", "name": "coverageApplicabilities", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item" } ] }
Example 2
This example describes how to create a coverage applicability item and suppplier for a warranty coverage using an ID reference for the item and supplier. For additional examples, see the Create and Update Supplier Warranty use case.
Example 2 Request Body
{ "ItemId": 300100566813001, "ItemOrganizationCode": "ORG1", "SupplierId": "999992000322154", "AutoAssignFlag": false, "ContractDefaultStatusCode": "ORA_DRAFT" }
Example 2 Response Body
{ "CoverageApplicabilityId": 300100568130766, "CoverageId": 300100568130739, "ItemId": 300100566813001, "ItemNumber": null, "ItemDescription": null, "ItemLongDescription": null, "ItemOrganizationId": 300100113363336, "ItemOrganizationCode": "ORG1", "ItemOrganizationName": null, "SupplierId": 999992000322154, "SupplierNumber": null, "SupplierName": null, "AutoAssignFlag": false, "ContractDefaultStatusCode": "ORA_DRAFT", "ContractDefaultStatus": null, "DisabledFlag": false, "ActiveEndDate": null, "CreatedBy": "USER", "CreationDate": "2022-10-28T14:55:15+00:00", "LastUpdatedBy": "USER", "LastUpdateDate": "2022-10-28T14:55:15.001+00:00", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763", "name": "coverageApplicabilities", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageApplicabilities/300100568130763", "name": "coverageApplicabilities", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item" } ] }