Jump to

• Request
• Response
• Examples

Create

post

/fscmRestApi/resources/11.13.18.05/assetWarrantyEntitlements

Request

Header Parameters

• 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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ClaimId: integer (int64)
• ClaimNumber: string
  Maximum Length: 255
• ContractId: integer (int64)
  Title: Contract ID
• ContractNumber: string
  Maximum Length: 255
• EntitlementDate: string (date)
  Title: Entitlement Date
• EntitlementDescription: string
  Maximum Length: 240
• EntitlementId: integer (int64)
  Title: Entitlement ID
• EntitlementNotes: string
  Title: Entitlement Note

  Maximum Length: 4000
• EntitlementNumber: string
  Title: Entitlement Number

  Maximum Length: 80
• EntitlementTypeCode: string
  Title: Entitlement Type Code

  Maximum Length: 30

  Default Value: ORA_OTHER
• OrganizationId: integer (int64)
  Title: Organization ID
• ReasonForRepairCode: string
  Title: Repair Transaction Code

  Maximum Length: 80
• ReasonForRepairCodeId: integer (int64)
• ReimbursementCurrencyCode: string
  Title: Reimbursement Currency Code

  Maximum Length: 20
• ReimbursementQuantity: number
  Title: Reimbursement Quantity

  Default Value: 0
• ReimbursementQuantityUOMCode: string
  Title: Unit of Measure Code

  Maximum Length: 3
• ReimbursementUnitCost: number
  Title: Reimbursement Unit Cost

  Default Value: 0
• TransactionCode: string
  Title: Transaction Code

  Maximum Length: 80
• TransactionCodeId: integer (int64)
  Title: Work Order Transaction ID
• WoOperationId: integer (int64)
  Title: Work Order Operation ID
• WorkAccomplishedCode: string
  Maximum Length: 80
• WorkAccomplishedCodeId: integer (int64)
• WorkOrderId: integer (int64)
  Title: Work Order ID

{
    "type":"object",
    "properties":{
        "ClaimId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ClaimNumber":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "ContractId":{
            "title":"Contract ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ContractNumber":{
            "maxLength":255,
            "type":"string",
            "nullable":true
        },
        "EntitlementDate":{
            "title":"Entitlement Date",
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "EntitlementDescription":{
            "maxLength":240,
            "type":"string",
            "nullable":true
        },
        "EntitlementId":{
            "title":"Entitlement ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "EntitlementNotes":{
            "title":"Entitlement Note",
            "maxLength":4000,
            "type":"string",
            "nullable":true
        },
        "EntitlementNumber":{
            "title":"Entitlement Number",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "EntitlementTypeCode":{
            "title":"Entitlement Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "default":"ORA_OTHER"
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReasonForRepairCode":{
            "title":"Repair Transaction Code",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "ReasonForRepairCodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ReimbursementCurrencyCode":{
            "title":"Reimbursement Currency Code",
            "maxLength":20,
            "type":"string",
            "nullable":true
        },
        "ReimbursementQuantity":{
            "title":"Reimbursement Quantity",
            "type":"number",
            "nullable":true,
            "default":0
        },
        "ReimbursementQuantityUOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":3,
            "type":"string",
            "nullable":true
        },
        "ReimbursementUnitCost":{
            "title":"Reimbursement Unit Cost",
            "type":"number",
            "nullable":true,
            "default":0
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "TransactionCodeId":{
            "title":"Work Order Transaction ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WoOperationId":{
            "title":"Work Order Operation ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkAccomplishedCode":{
            "maxLength":80,
            "type":"string",
            "nullable":true
        },
        "WorkAccomplishedCodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• 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.

Body ()

Root Schema : assetWarrantyEntitlements-item-response

Type: object

Show Source

• AssetDescription: string
  Title: Asset Description

  Read Only: true

  Maximum Length: 240
• AssetId: integer (int64)
  Title: Asset ID

  Read Only: true
• AssetNumber: string
  Title: Number

  Read Only: true

  Maximum Length: 80
• AssetSerialNumber: string
  Title: Serial Number

  Read Only: true

  Maximum Length: 80
• ClaimId: integer (int64)
• ClaimNumber: string
  Maximum Length: 255
• ContractId: integer (int64)
  Title: Contract ID
• ContractNumber: string
  Maximum Length: 255
• CostTransactionCurrency: string
  Title: Cost Transaction Currency

  Read Only: true

  Maximum Length: 255
• CostTransactionCurrencyCode: string
  Title: Cost Transaction Currency Code

  Read Only: true

  Maximum Length: 20
• CostTransactionId: integer (int64)
  Title: Cost Transaction ID

  Read Only: true
• CostTransactionQuantity: number
  Title: Cost Transaction Qty

  Read Only: true
• CostTransactionTotal: integer (int64)
  Title: Cost Transaction Total Cost

  Read Only: true
• CostTransactionType: string
  Title: Cost Transaction Type

  Read Only: true

  Maximum Length: 80
• CostTransactionTypeCode: string
  Title: Cost Transaction Type Code

  Read Only: true

  Maximum Length: 30
• CostTransactionUnitCost: number
  Title: Cost Transaction Unit Cost

  Read Only: true
• CostTransactionUOM: string
  Title: Cost Transaction Unit of Measure

  Read Only: true

  Maximum Length: 255
• CostTransactionUOMCode: string
  Title: Unit of Measure Code

  Read Only: true

  Maximum Length: 3
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true
• EntitlementDate: string (date)
  Title: Entitlement Date
• EntitlementDescription: string
  Maximum Length: 240
• EntitlementId: integer (int64)
  Title: Entitlement ID
• EntitlementNotes: string
  Title: Entitlement Note

  Maximum Length: 4000
• EntitlementNumber: string
  Title: Entitlement Number

  Maximum Length: 80
• EntitlementType: string
  Title: Entitlement Type

  Read Only: true

  Maximum Length: 80
• EntitlementTypeCode: string
  Title: Entitlement Type Code

  Maximum Length: 30

  Default Value: ORA_OTHER
• LastUpdateDate: string (date-time)
  Title: Last Update Date

  Read Only: true
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ManuallyCreatedFlag: boolean
  Title: Manually Created Indicator

  Read Only: true

  Maximum Length: 1

  Default Value: true
• OperationName: string
  Title: Work Order Operation Name

  Read Only: true

  Maximum Length: 120
• OperationSequenceNumber: number
  Title: Operation Sequence

  Read Only: true
• OrganizationCode: string
  Read Only: true

  Maximum Length: 18
• OrganizationId: integer (int64)
  Title: Organization ID
• ReasonForRepairCode: string
  Title: Repair Transaction Code

  Maximum Length: 80
• ReasonForRepairCodeId: integer (int64)
• ReasonForRepairCodeName: string
  Title: Reason for Repair

  Read Only: true

  Maximum Length: 240
• ReimbursementCurrency: string
  Title: Reimbursement Currency

  Read Only: true

  Maximum Length: 255
• ReimbursementCurrencyCode: string
  Title: Reimbursement Currency Code

  Maximum Length: 20
• ReimbursementQuantity: number
  Title: Reimbursement Quantity

  Default Value: 0
• ReimbursementQuantityUOM: string
  Title: Reimbursement Quantity Unit of Measure

  Read Only: true

  Maximum Length: 120
• ReimbursementQuantityUOMCode: string
  Title: Unit of Measure Code

  Maximum Length: 3
• ReimbursementTotalCost: number
  Title: Reimbursement Total Cost

  Read Only: true
• ReimbursementUnitCost: number
  Title: Reimbursement Unit Cost

  Default Value: 0
• RootAssetId: integer (int64)
  Read Only: true
• TransactionCode: string
  Title: Transaction Code

  Maximum Length: 80
• TransactionCodeId: integer (int64)
  Title: Work Order Transaction ID
• TransactionCodeName: string
  Title: Transaction Code Name

  Read Only: true

  Maximum Length: 540
• WarrantyEntitledFlag: boolean
  Title: Warranty Entitled Indicator

  Read Only: true

  Maximum Length: 1
• WarrantyProviderId: integer (int64)
  Read Only: true
• WarrantyProviderName: string
  Title: Warranty Provider Name

  Read Only: true

  Maximum Length: 255
• WarrantyProviderNumber: string
  Title: Warranty Provider Number

  Read Only: true

  Maximum Length: 255
• WoOperationId: integer (int64)
  Title: Work Order Operation ID
• WoOperationMaterialId: integer (int64)
  Title: Work Order Material ID

  Read Only: true
• WoOperationReference: string
  Title: Work Order Operation Reference

  Read Only: true

  Maximum Length: 255
• WoOperationResourceId: integer (int64)
  Title: Work Order Resource ID

  Read Only: true
• WorkAccomplishedCode: string
  Maximum Length: 80
• WorkAccomplishedCodeId: integer (int64)
• WorkAccomplishedCodeName: string
  Title: Work to Be Accomplished

  Read Only: true

  Maximum Length: 240
• WorkOrderId: integer (int64)
  Title: Work Order ID
• WorkOrderNumber: string
  Title: Work Order

  Read Only: true

  Maximum Length: 120

{
    "type":"object",
    "properties":{
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Serial Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ClaimNumber":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ContractId":{
            "title":"Contract ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ContractNumber":{
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "CostTransactionCurrency":{
            "title":"Cost Transaction Currency",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionCurrencyCode":{
            "title":"Cost Transaction Currency Code",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionId":{
            "title":"Cost Transaction ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CostTransactionQuantity":{
            "title":"Cost Transaction Qty",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionTotal":{
            "title":"Cost Transaction Total Cost",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":255
            }
        },
        "CostTransactionType":{
            "title":"Cost Transaction Type",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionTypeCode":{
            "title":"Cost Transaction Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionUOM":{
            "title":"Cost Transaction Unit of Measure",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionUOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":3,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionUnitCost":{
            "title":"Cost Transaction Unit Cost",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementDate":{
            "title":"Entitlement Date",
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementDescription":{
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementId":{
            "title":"Entitlement ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EntitlementNotes":{
            "title":"Entitlement Note",
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementNumber":{
            "title":"Entitlement Number",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementType":{
            "title":"Entitlement Type",
            "maxLength":80,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementTypeCode":{
            "title":"Entitlement Type Code",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "default":"ORA_OTHER",
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyCreatedFlag":{
            "title":"Manually Created Indicator",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Work Order Operation Name",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":18,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReasonForRepairCode":{
            "title":"Repair Transaction Code",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReasonForRepairCodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ReasonForRepairCodeName":{
            "title":"Reason for Repair",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReimbursementCurrency":{
            "title":"Reimbursement Currency",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReimbursementCurrencyCode":{
            "title":"Reimbursement Currency Code",
            "maxLength":20,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReimbursementQuantity":{
            "title":"Reimbursement Quantity",
            "type":"number",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "ReimbursementQuantityUOM":{
            "title":"Reimbursement Quantity Unit of Measure",
            "maxLength":120,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReimbursementQuantityUOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":3,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "ReimbursementTotalCost":{
            "title":"Reimbursement Total Cost",
            "type":"number",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReimbursementUnitCost":{
            "title":"Reimbursement Unit Cost",
            "type":"number",
            "nullable":true,
            "default":0,
            "x-queryable":true
        },
        "RootAssetId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCodeId":{
            "title":"Work Order Transaction ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionCodeName":{
            "title":"Transaction Code Name",
            "maxLength":540,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyEntitledFlag":{
            "title":"Warranty Entitled Indicator",
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyProviderId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WarrantyProviderName":{
            "title":"Warranty Provider Name",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationId":{
            "title":"Work Order Operation ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoOperationMaterialId":{
            "title":"Work Order Material ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WoOperationReference":{
            "title":"Work Order Operation Reference",
            "maxLength":255,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "WoOperationResourceId":{
            "title":"Work Order Resource ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkAccomplishedCode":{
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "WorkAccomplishedCodeId":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkAccomplishedCodeName":{
            "title":"Work to Be Accomplished",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":120,
            "type":"string",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

These examples describe how to create an entitlement.

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/assetWarrantyEntitlements"

Example 1

This example describes how to create a warranty entitlement for a claim using number references.

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.

{
"EntitlementDate": "2023-04-05",
"EntitlementDescription": "New Manual Entitlement Added",
"ClaimNumber": "100101585480500",
"ReasonForRepairCode": "01",
"TransactionCode": "013-000-001",
"WorkAccomplishedCode": "W-CODE",
"EntitlementNotes": "Manual entitlement Added for Testing",
"ContractNumber": "300100571253016"
}

Example 1 Response Body

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

{
    "EntitlementId": 300100582777631,
    "EntitlementNumber": "300100582777631",
    "EntitlementDate": "2023-04-05",
    "EntitlementTypeCode": "ORA_OTHER",
    "EntitlementType": null,
    "EntitlementDescription": "New Manual Entitlement Added",
    "ClaimId": 100101585480500,
    "ClaimNumber": null,
    "ManuallyCreatedFlag": true,
    "WarrantyEntitledFlag": true,
    "ContractId": 300100571253016,
    "ContractNumber": null,
    "WarrantyProviderId": "999992000322153",
    "WarrantyProviderNumber": "7141",
    "WarrantyProviderName": "Computer Service and Rentals",
    "OrganizationId": 300100113363336,
    "OrganizationCode": null,
    "WorkOrderId": 300100582586720,
    "WorkOrderNumber": null,
    "AssetId": 300100570947822,
    "AssetNumber": null,
    "AssetDescription": null,
    "AssetSerialNumber": null,
    "RootAssetId": null,
    "WoOperationId": null,
    "OperationSequenceNumber": null,
    "OperationName": null,
    "WoOperationResourceId": null,
    "WoOperationReference": null,
    "WoOperationMaterialId": null,
    "CostTransactionId": null,
    "ReasonForRepairCode": "01",
    "ReasonForRepairCodeName": null,
    "TransactionCode": "013-000-001",
    "TransactionCodeName": null,
    "WorkAccomplishedCode": "W-CODE",
    "WorkAccomplishedCodeName": null,
    "CostTransactionTypeCode": null,
    "CostTransactionType": null,
    "CostTransactionQuantity": null,
    "CostTransactionUOMCode": null,
    "CostTransactionUOM": null,
    "CostTransactionUnitCost": null,
    "CostTransactionTotal": null,
    "CostTransactionCurrencyCode": null,
    "CostTransactionCurrency": null,
    "ReimbursementQuantity": 0,
    "ReimbursementQuantityUOMCode": null,
    "ReimbursementQuantityUOM": null,
    "ReimbursementUnitCost": 0,
    "ReimbursementTotalCost": 0,
    "ReimbursementCurrencyCode": "USD",
    "ReimbursementCurrency": "US Dollar",
    "EntitlementNotes": "Manual entitlement Added for Testing",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2023-04-05T20:03:44+00:00",
    "LastUpdatedBy": "MNT_QA",
    "LastUpdateDate": "2023-04-05T20:03:44.001+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/300100582777631",
            "name": "assetWarrantyEntitlements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/300100582777631",
            "name": "assetWarrantyEntitlements",
            "kind": "item"
        }
    ]
}

Example 2

These examples describe how to create a warranty entitlement for a claim using ID references..

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.

{
"EntitlementDate": "2023-04-05",
"EntitlementDescription": "New Manual Entitlement Added",
"ClaimId": 100101585480500,
"ReasonForRepairCode": "01",
"TransactionCode": "013-000-001",
"WorkAccomplishedCode": "W-CODE",
"EntitlementNotes": "Manual entitlement Added for Testing",
"ContractId": 300100571253016
}

Example 2 Response Body

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

{
    "EntitlementId": 300100582777631,
    "EntitlementNumber": "300100582777631",
    "EntitlementDate": "2023-04-05",
    "EntitlementTypeCode": "ORA_OTHER",
    "EntitlementType": null,
    "EntitlementDescription": "New Manual Entitlement Added",
    "ClaimId": 100101585480500,
    "ClaimNumber": null,
    "ManuallyCreatedFlag": true,
    "WarrantyEntitledFlag": true,
    "ContractId": 300100571253016,
    "ContractNumber": null,
    "WarrantyProviderId": "999992000322153",
    "WarrantyProviderNumber": "7141",
    "WarrantyProviderName": "Computer Service and Rentals",
    "OrganizationId": 300100113363336,
    "OrganizationCode": null,
    "WorkOrderId": 300100582586720,
    "WorkOrderNumber": null,
    "AssetId": 300100570947822,
    "AssetNumber": null,
    "AssetDescription": null,
    "AssetSerialNumber": null,
    "RootAssetId": null,
    "WoOperationId": null,
    "OperationSequenceNumber": null,
    "OperationName": null,
    "WoOperationResourceId": null,
    "WoOperationReference": null,
    "WoOperationMaterialId": null,
    "CostTransactionId": null,
    "ReasonForRepairCode": "01",
    "ReasonForRepairCodeName": null,
    "TransactionCode": "013-000-001",
    "TransactionCodeName": null,
    "WorkAccomplishedCode": "W-CODE",
    "WorkAccomplishedCodeName": null,
    "CostTransactionTypeCode": null,
    "CostTransactionType": null,
    "CostTransactionQuantity": null,
    "CostTransactionUOMCode": null,
    "CostTransactionUOM": null,
    "CostTransactionUnitCost": null,
    "CostTransactionTotal": null,
    "CostTransactionCurrencyCode": null,
    "CostTransactionCurrency": null,
    "ReimbursementQuantity": 0,
    "ReimbursementQuantityUOMCode": null,
    "ReimbursementQuantityUOM": null,
    "ReimbursementUnitCost": 0,
    "ReimbursementTotalCost": 0,
    "ReimbursementCurrencyCode": "USD",
    "ReimbursementCurrency": "US Dollar",
    "EntitlementNotes": "Manual entitlement Added for Testing",
    "CreatedBy": "MNT_QA",
    "CreationDate": "2023-04-05T20:03:44+00:00",
    "LastUpdatedBy": "MNT_QA",
    "LastUpdateDate": "2023-04-05T20:03:44.001+00:00",
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/300100582777631",
            "name": "assetWarrantyEntitlements",
            "kind": "item",
            "properties": {
                "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
            }
        },
        {
            "rel": "canonical",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/300100582777631",
            "name": "assetWarrantyEntitlements",
            "kind": "item"
        }
    ]
}

Back to Top