Create transaction codes
/fscmRestApi/resources/11.13.18.05/assetWarrantyCoverages/{CoverageId}/child/coverageTransactionCodes
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
-
DisabledFlag: boolean
Title:
Disabled Indicator
Maximum Length:80
Value that indicates if the transaction code is disabled for a warranty coverage.. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:255
Value that uniquely identifies the transaction code for the coverage. -
TransactionCodeId: integer
(int64)
Title:
Transaction Code ID
Value that uniquely identifies the 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
-
ActiveEndDate: string
(date)
Title:
Active End Date
Read Only:true
Value that identifies the date when the transaction code for the coverage becomes ineffective. -
CoverageId: integer
(int64)
Title:
Coverage ID
Read Only:true
Value that uniquely identifies the coverage ID to which the transaction code belong. -
CoverageTransactionCodeId: integer
(int64)
Title:
Coverage Transaction Code ID
Read Only:true
Value that uniquely identifies the coverage transaction code ID. -
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 indicates if the transaction code is disabled for a warranty 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. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:255
Value that uniquely identifies the transaction code for the coverage. -
TransactionCodeDescription: string
Title:
Transaction Code Description
Read Only:true
Maximum Length:540
Value that identifies the description of the transaction code. -
TransactionCodeId: integer
(int64)
Title:
Transaction Code ID
Value that uniquely identifies the transaction code ID. -
TransactionCodeName: string
Title:
Transaction Code Name
Read Only:true
Maximum Length:240
Value that identifies name of the transaction code. -
TransactionType: string
Title:
Transaction Type
Read Only:true
Maximum Length:80
Value that identifies the meaning of the transaction code. -
TransactionTypeCode: string
Title:
Transaction Type Code
Read Only:true
Maximum Length:30
Value that uniquely identifies type of the transaction code.
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/coverageTransactionCodes"
Example 1
This example describes how to create a coverage transaction code for a warranty coverage using a code reference for the meter. For additional examples, see the Create and Update Supplier Warranty use case.
Example 1 Request Body
{ "TransactionCode": "013-000-100" }
Example 1 Response Body
{ "CoverageTransactionCodeId": 300100568130799, "CoverageId": 300100568130739, "TransactionCodeId": 300100568130750, "TransactionTypeCode": null, "TransactionType": null, "TransactionCode": "013-000-100", "TransactionCodeName": null, "TransactionCodeDescription": null, "DisabledFlag": false, "ActiveEndDate": null, "CreatedBy": "USER", "CreationDate": "2022-10-28T15:21:57+00:00", "LastUpdateDate": "2022-10-28T15:21:57.001+00:00", "LastUpdatedBy": "USER", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes/300100568130799", "name": "coverageTransactionCodes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes/300100568130799", "name": "coverageTransactionCodes", "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 transaction code for a warranty coverage using an ID reference for the meter. For additional examples, see the Create and Update Supplier Warranty use case.
Example 2 Request Body
{ "TransactionCodeId": 300100568130751 }
Example 2 Response Body
{ "CoverageTransactionCodeId": 300100568130800, "CoverageId": 300100568130739, "TransactionCodeId": 300100568130751, "TransactionTypeCode": null, "TransactionType": null, "TransactionCode": null, "TransactionCodeName": null, "TransactionCodeDescription": null, "DisabledFlag": false, "ActiveEndDate": null, "CreatedBy": "USER", "CreationDate": "2022-10-28T15:21:57+00:00", "LastUpdateDate": "2022-10-28T15:21:57.001+00:00", "LastUpdatedBy": "USER", "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes/300100568130799", "name": "coverageTransactionCodes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739/child/coverageTransactionCodes/300100568130799", "name": "coverageTransactionCodes", "kind": "item" }, { "rel": "parent", "href": "https://servername/fscmRestApi/resources/version/assetWarrantyCoverages/300100568130739", "name": "assetWarrantyCoverages", "kind": "item" } ] }