Jump to

• Request
• Response
• Examples

Get all claims

get

/fscmRestApi/resources/11.13.18.05/assetWarrantyClaims

Request

Query Parameters

• expand: string
  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).
• fields: string
  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
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the claim according to the claim identifier.
    Finder Variables:
    • ClaimId; integer; Value that uniquely identifies the claim..
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  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
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • ActiveEndDate; string; Date that indicates if a claim is disabled. This date is set by the disabled flag = true.
  • AssetDescription; string; Description of the asset.
  • AssetId; integer; Value that uniquely identifies an asset.
  • AssetNumber; string; Number that uniquely identifies an asset.
  • AssetSerialNumber; string; Serial number of the asset.
  • ClaimAdjustmentAmount; number; Total amount of the adjustments to the claim total.
  • ClaimAssignedId; integer; Value that uniquely identifies the employee who is assigned to the claim.
  • ClaimAssignedToName; string; Name of the employee who is assigned to the claim.
  • ClaimCurrencyCode; string; Abbreviation that uniquely identifies the currency code of the claim amount.
  • ClaimCurrencyConversionRate; number; Rate of a claim currency converstion.
  • ClaimCurrencyConversionType; string; Type of a claim currency converstion.
  • ClaimCurrencyConversionTypeCode; string; Abbreviation that uniquely identifies the claim currency conversion type. A list of accepted values is defined in the lookup type . This attribute is optional to create the warranty claim.
  • ClaimDate; string; Date of a warranty claim. This value is required.
  • ClaimDescription; string; Detailed description of the claim.
  • ClaimEquipmentAmount; number; Total amount of the equipment claimed for reimbursement in the claim.
  • ClaimId; integer; Value that uniquely identifies the warranty claim. The application creates this value when it creates the claim.
  • ClaimMaterialAmount; number; Total amount of the materials claimed for reimbursement in the claim.
  • ClaimNotes; string; Notes of the warranty claim.
  • ClaimNumber; string; Number that uniquely identifies the warranty claim. The application creates this value when it creates the claim.
  • ClaimOtherAmount; number; Total amount of the other repairs claimed for reimbursement in the claim.
  • ClaimReference; string; Reference of a warranty claim reimbursement.
  • ClaimReimbursementAmount; number; Total amount of the claim reimbursement.
  • ClaimReimbursementType; string; Type of claim reimbursement.
  • ClaimReimbursementTypeCode; string; Abbreviation that uniquely identifies the type of claim reimbursement. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIM_REIMB_TYPE. This attribute is optional for creating the warranty claim.
  • ClaimResolutionDate; string; Resolution Date of the warranty claim. This value is optional.
  • ClaimResourceAmount; number; Total amount of the resources claimed for reimbursement in the claim.
  • ClaimStandardRepairAmount; number; Total amount of the standard repairs claimed for reimbursement in the claim.
  • ClaimStatus; string; Status of a warranty claim.
  • ClaimStatusCode; string; Abbreviation that uniquely identifies the claim status. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIMS_STATUS. This attribute is required to create the warranty claim.
  • ClaimSubmitByDate; string; Date in which you must submit a claim to the provider.
  • ClaimSubmitByNumberOfDays; number; Value for the number of days to submit a claim to the provider.
  • ClaimTotalAmount; number; Total amount of the claim.
  • ClaimType; string; Type of a warranty claim.
  • ClaimTypeCode; string; Abbreviation that uniquely identifies the claim type. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIMS_TYPE. This attribute is optional to create the warranty claim.
  • CreatedBy; string; Login username of the user who created the record.
  • CreationDate; string; Date when the record was created.
  • LastUpdateDate; string; Date when the record was updated.
  • LastUpdatedBy; string; Login user name of the user who updated the record.
  • ManuallyCreatedFlag; boolean; Indicates if a claim is manually created or not.
  • MatchToTransactionCodeFlag; boolean; Indicates if the claim entitlements were created only for cost transations with matching repair transaction coding to warranty contracts.
  • ObjectId; integer; Value that uniquely identifies the the object for which the claim was created.
  • ObjectType; string; Name of the object for which the claim was created.
  • ObjectTypeCode; string; Abbreviation that uniquely identifies the object for which the claim was created. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIM_OBJECT_TYPE. This attribute is required to create the warranty claim.
  • OrganizationCode; string; Abbreviation that uniquely identifies the work order organization.
  • OrganizationId; integer; Value that uniquely identifies the work order organization.
  • PrimaryReasonForRepairCode; string; Abbreviation that uniquely identifies the work order operation reason for repair code.
  • PrimaryReasonForRepairName; string; Name of the work order operation reason for repair code.
  • RootAssetId; integer; Value that uniquely identifies a root asset.
  • WarrantyProviderId; integer; Value that uniquely identifies the warranty provider who provides warranty coverage.
  • WarrantyProviderLaborRate; number; Value for the hourly labor rate for the provider.
  • WarrantyProviderName; string; Name of the warranty provider who provides warranty coverage.
  • WarrantyProviderNumber; string; Number that uniquely identifies the warranty provider who provides warranty coverage.
  • WorkOrderId; integer; Value that uniquely identifies the work order associated to the warranty claim. This attribute is read-only.
  • WorkOrderNumber; string; Number that uniquely identifies the work order for the claim.
  • WorkOrderStatus; string; Name of the work order status.
  • WorkOrderStatusCode; string; Abbreviation that uniquely identifies the work order status.
  • WorkOrderTotalCost; number; Total cost of the work order.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

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 : assetWarrantyClaims

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/assetWarrantyClaims-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object assetWarrantyClaims-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyClaims-item-response"
    }
}

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 : assetWarrantyClaims-item-response

Type: object

Show Source

• ActiveEndDate: string (date)
  Title: Active End Date

  Date that indicates if a claim is disabled. This date is set by the disabled flag = true.
• AssetDescription: string
  Title: Asset Description

  Read Only: true

  Maximum Length: 240

  Description of the asset.
• AssetId: integer (int64)
  Title: Asset ID

  Read Only: true

  Value that uniquely identifies an asset.
• AssetNumber: string
  Title: Asset Number

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies an asset.
• AssetSerialNumber: string
  Title: Asset Serial Number

  Read Only: true

  Maximum Length: 80

  Serial number of the asset.
• ClaimAdjustmentAmount: number
  Title: Claim Adjustment Amount

  Default Value: 0

  Total amount of the adjustments to the claim total.
• ClaimAssignedId: integer (int64)
  Title: Claim Assigned To ID

  Value that uniquely identifies the employee who is assigned to the claim.
• ClaimAssignedToName: string
  Title: Claim Assigned To

  Maximum Length: 255

  Name of the employee who is assigned to the claim.
• ClaimCurrency: string
  Title: Claim Currency

  Read Only: true

  Maximum Length: 255

  Name of the claim amount currency code.
• ClaimCurrencyCode: string
  Title: Claim Currency Code

  Read Only: true

  Maximum Length: 20

  Abbreviation that uniquely identifies the currency code of the claim amount.
• ClaimCurrencyConversionRate: number
  Title: Currency Conversion Rate

  Rate of a claim currency converstion.
• ClaimCurrencyConversionType: string
  Title: Currency Conversion Type

  Maximum Length: 30

  Type of a claim currency converstion.
• ClaimCurrencyConversionTypeCode: string
  Title: Currency Conversion Type Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the claim currency conversion type. A list of accepted values is defined in the lookup type . This attribute is optional to create the warranty claim.
• ClaimDate: string (date)
  Title: Claim Date

  Date of a warranty claim. This value is required.
• ClaimDescription: string
  Title: Claim Description

  Maximum Length: 240

  Detailed description of the claim.
• ClaimEquipmentAmount: number
  Title: Work Order Equipment Cost

  Read Only: true

  Default Value: 0

  Total amount of the equipment claimed for reimbursement in the claim.
• ClaimId: integer (int64)
  Title: Claim ID

  Read Only: true

  Value that uniquely identifies the warranty claim. The application creates this value when it creates the claim.
• ClaimMaterialAmount: number
  Title: Work Order Material Cost

  Read Only: true

  Default Value: 0

  Total amount of the materials claimed for reimbursement in the claim.
• ClaimNotes: string
  Title: Claim Notes

  Maximum Length: 4000

  Notes of the warranty claim.
• ClaimNumber: string
  Title: Claim Number

  Read Only: true

  Maximum Length: 80

  Number that uniquely identifies the warranty claim. The application creates this value when it creates the claim.
• ClaimOtherAmount: number
  Title: Claim Other Amount

  Read Only: true

  Default Value: 0

  Total amount of the other repairs claimed for reimbursement in the claim.
• ClaimReference: string
  Title: Claim Reference

  Maximum Length: 120

  Reference of a warranty claim reimbursement.
• ClaimReimbursementAmount: number
  Title: Reimbursement Amount

  Default Value: 0

  Total amount of the claim reimbursement.
• ClaimReimbursementType: string
  Title: Reimbursement Type

  Read Only: true

  Maximum Length: 80

  Type of claim reimbursement.
• ClaimReimbursementTypeCode: string
  Title: Reimbursement Type Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the type of claim reimbursement. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIM_REIMB_TYPE. This attribute is optional for creating the warranty claim.
• ClaimResolutionDate: string (date)
  Title: Claim Resolution Date

  Resolution Date of the warranty claim. This value is optional.
• ClaimResourceAmount: number
  Title: Work Order Labor Cost

  Read Only: true

  Default Value: 0

  Total amount of the resources claimed for reimbursement in the claim.
• ClaimStandardRepairAmount: number
  Title: Claim Standard Repair Amount

  Read Only: true

  Default Value: 0

  Total amount of the standard repairs claimed for reimbursement in the claim.
• ClaimStatus: string
  Title: Claim Status

  Read Only: true

  Maximum Length: 80

  Status of a warranty claim.
• ClaimStatusCode: string
  Title: Claim Status Code

  Maximum Length: 30

  Default Value: ORA_PENDING_REVIEW

  Abbreviation that uniquely identifies the claim status. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIMS_STATUS. This attribute is required to create the warranty claim.
• ClaimSubmitByDate: string (date)
  Title: Claim Submit by Date

  Date in which you must submit a claim to the provider.
• ClaimSubmitByNumberOfDays: number
  Title: Submission Due In

  Read Only: true

  Value for the number of days to submit a claim to the provider.
• ClaimTotalAmount: number
  Title: Claim Amount

  Read Only: true

  Default Value: 0

  Total amount of the claim.
• ClaimType: string
  Title: Claim Type

  Read Only: true

  Maximum Length: 80

  Type of a warranty claim.
• ClaimTypeCode: string
  Title: Claim Type Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the claim type. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIMS_TYPE. This attribute is optional to create the warranty claim.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Login username of the user who created the record.
• CreationDate: string (date-time)
  Read Only: true

  Date when the record was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the record was updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Login user name of the user who updated the record.
• links: array Links
  Title: Links

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

  Maximum Length: 1

  Indicates if a claim is manually created or not.
• MatchToTransactionCodeFlag: boolean
  Title: Match Transaction Codes

  Read Only: true

  Maximum Length: 1

  Indicates if the claim entitlements were created only for cost transations with matching repair transaction coding to warranty contracts.
• ObjectId: integer (int64)
  Title: Object ID

  Value that uniquely identifies the the object for which the claim was created.
• ObjectType: string
  Title: Object Type

  Read Only: true

  Maximum Length: 80

  Name of the object for which the claim was created.
• ObjectTypeCode: string
  Title: Object Type Code

  Maximum Length: 30

  Abbreviation that uniquely identifies the object for which the claim was created. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIM_OBJECT_TYPE. This attribute is required to create the warranty claim.
• OrganizationCode: string
  Title: Organization Code

  Read Only: true

  Maximum Length: 18

  Abbreviation that uniquely identifies the work order organization.
• OrganizationId: integer (int64)
  Title: Organization ID

  Read Only: true

  Value that uniquely identifies the work order organization.
• PrimaryReasonForRepairCode: string
  Title: Primary Reason for Repair Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order operation reason for repair code.
• PrimaryReasonForRepairName: string
  Title: Primary Reason for Repair

  Read Only: true

  Maximum Length: 240

  Name of the work order operation reason for repair code.
• RootAssetId: integer (int64)
  Title: Root Asset ID

  Read Only: true

  Value that uniquely identifies a root asset.
• WarrantyProviderId: integer (int64)
  Title: Warranty Provider ID

  Value that uniquely identifies the warranty provider who provides warranty coverage.
• WarrantyProviderLaborRate: number
  Title: Hourly Rate

  Value for the hourly labor rate for the provider.
• WarrantyProviderName: string
  Title: Warranty Provider Name

  Read Only: true

  Maximum Length: 360

  Name of the warranty provider who provides warranty coverage.
• WarrantyProviderNumber: string
  Title: Warranty Provider ID

  Maximum Length: 255

  Number that uniquely identifies the warranty provider who provides warranty coverage.
• WorkOrderEquipmentCost: number
  Title: Work Order Equipment Cost

  Read Only: true

  Total cost of the equipment resources transacted in the work order.
• WorkOrderId: integer (int64)
  Title: Work Order ID

  Read Only: true

  Value that uniquely identifies the work order associated to the warranty claim. This attribute is read-only.
• WorkOrderLaborCost: number
  Title: Work Order Labor Cost

  Read Only: true

  Total cost of the people resources transacted in the work order.
• WorkOrderMaterialCost: number
  Title: Work Order Material Cost

  Read Only: true

  Total cost of the materials transacted in the work order.
• WorkOrderNumber: string
  Title: Work Order Number

  Read Only: true

  Maximum Length: 120

  Number that uniquely identifies the work order for the claim.
• WorkOrderStatus: string
  Title: Work Order Status

  Read Only: true

  Maximum Length: 120

  Name of the work order status.
• WorkOrderStatusCode: string
  Title: Work Order Status Code

  Read Only: true

  Maximum Length: 30

  Abbreviation that uniquely identifies the work order status.
• WorkOrderTotalCost: number
  Title: Work Order Total Cost

  Read Only: true

  Total cost of the work order.

{
    "type":"object",
    "properties":{
        "ClaimOtherAmount":{
            "title":"Claim Other Amount",
            "type":"number",
            "description":"Total amount of the other repairs claimed for reimbursement in the claim.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ClaimCurrency":{
            "title":"Claim Currency",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the claim amount currency code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimAdjustmentAmount":{
            "title":"Claim Adjustment Amount",
            "type":"number",
            "description":"Total amount of the adjustments to the claim total.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimDescription":{
            "title":"Claim Description",
            "maxLength":"240",
            "type":"string",
            "description":"Detailed description of the claim.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "WorkOrderStatus":{
            "title":"Work Order Status",
            "maxLength":"120",
            "type":"string",
            "description":"Name of the work order status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "title":"Object Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the object for which the claim was created.   A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIM_OBJECT_TYPE. This attribute is required to create the warranty claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimReimbursementType":{
            "title":"Reimbursement Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of claim reimbursement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimAssignedToName":{
            "title":"Claim Assigned To",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the employee who is assigned to the claim.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Asset Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies an asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimReference":{
            "title":"Claim Reference",
            "maxLength":"120",
            "type":"string",
            "description":"Reference of a warranty claim reimbursement.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimType":{
            "title":"Claim Type",
            "maxLength":"80",
            "type":"string",
            "description":"Type of a warranty claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderTotalCost":{
            "title":"Work Order Total Cost",
            "type":"number",
            "description":"Total cost of the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderStatusCode":{
            "title":"Work Order Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order status.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderLaborCost":{
            "title":"Work Order Labor Cost",
            "type":"number",
            "description":"Total cost of the people resources transacted in the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ClaimSubmitByNumberOfDays":{
            "title":"Submission Due In",
            "type":"number",
            "description":"Value for the number of days to submit a claim to the provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimStandardRepairAmount":{
            "title":"Claim Standard Repair Amount",
            "type":"number",
            "description":"Total amount of the standard repairs claimed for reimbursement in the claim.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ClaimDate":{
            "title":"Claim Date",
            "type":"string",
            "description":"Date of a warranty claim.  This value is required.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ClaimAssignedId":{
            "title":"Claim Assigned To ID",
            "type":"integer",
            "description":"Value that uniquely identifies the employee who is assigned to the claim.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkOrderEquipmentCost":{
            "title":"Work Order Equipment Cost",
            "type":"number",
            "description":"Total cost of the equipment resources transacted in the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimTotalAmount":{
            "title":"Claim Amount",
            "type":"number",
            "description":"Total amount of the claim.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login user name of the user who updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"Login username of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimCurrencyConversionType":{
            "title":"Currency Conversion Type",
            "maxLength":"30",
            "type":"string",
            "description":"Type of a claim currency converstion.",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyProviderName":{
            "title":"Warranty Provider Name",
            "maxLength":"360",
            "type":"string",
            "description":"Name of the warranty provider who provides warranty coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimTypeCode":{
            "title":"Claim Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the claim type. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIMS_TYPE. This attribute is optional to create the warranty claim.",
            "nullable":true,
            "x-queryable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider ID",
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the warranty provider who provides warranty coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Asset Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Serial number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order Number",
            "maxLength":"120",
            "type":"string",
            "description":"Number that uniquely identifies the work order for the claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimMaterialAmount":{
            "title":"Work Order Material Cost",
            "type":"number",
            "description":"Total amount of the materials claimed for reimbursement in the claim.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ClaimReimbursementAmount":{
            "title":"Reimbursement Amount",
            "type":"number",
            "description":"Total amount of the claim reimbursement.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "WarrantyProviderId":{
            "title":"Warranty Provider ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider who provides warranty coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies an asset.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClaimSubmitByDate":{
            "title":"Claim Submit by Date",
            "type":"string",
            "description":"Date in which you must submit a claim to the provider.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimReimbursementTypeCode":{
            "title":"Reimbursement Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the type of claim reimbursement. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIM_REIMB_TYPE. This attribute is optional for creating the warranty claim.",
            "nullable":true,
            "x-queryable":true
        },
        "PrimaryReasonForRepairName":{
            "title":"Primary Reason for Repair",
            "maxLength":"240",
            "type":"string",
            "description":"Name of the work order operation reason for repair  code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimId":{
            "title":"Claim ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty claim. The application creates this value when it creates the claim.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "ClaimResourceAmount":{
            "title":"Work Order Labor Cost",
            "type":"number",
            "description":"Total amount of the resources claimed for reimbursement in the claim.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "MatchToTransactionCodeFlag":{
            "title":"Match Transaction Codes",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if the claim entitlements were created only for cost transations with matching repair transaction coding to warranty contracts.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderMaterialCost":{
            "title":"Work Order Material Cost",
            "type":"number",
            "description":"Total cost of the materials transacted in the work order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ClaimCurrencyCode":{
            "title":"Claim Currency Code",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency code of the claim amount.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimStatusCode":{
            "title":"Claim Status Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the claim status. A list of accepted values is defined in the lookup type ORA_CSE_WTY_CLAIMS_STATUS. This attribute is required to create the warranty claim.",
            "nullable":false,
            "default":"ORA_PENDING_REVIEW",
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the work order organization.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RootAssetId":{
            "title":"Root Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies a root asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectType":{
            "title":"Object Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the object for which the claim was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyCreatedFlag":{
            "title":"Manually Created Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if a claim is manually created or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimNotes":{
            "title":"Claim Notes",
            "maxLength":"4000",
            "type":"string",
            "description":"Notes of the warranty claim.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimEquipmentAmount":{
            "title":"Work Order Equipment Cost",
            "type":"number",
            "description":"Total amount of the equipment claimed for reimbursement in the claim.",
            "nullable":true,
            "readOnly":true,
            "default":"0",
            "x-queryable":true
        },
        "ClaimCurrencyConversionTypeCode":{
            "title":"Currency Conversion Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the claim currency conversion type. A list of accepted values is defined in the lookup type <tbd>. This attribute is optional to create the warranty claim.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "title":"Organization Code",
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveEndDate":{
            "title":"Active End Date",
            "type":"string",
            "description":"Date that indicates if a claim is disabled.  This date is set by the disabled flag = true.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimNumber":{
            "title":"Claim Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies the warranty claim.  The application creates this value when it creates the claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyProviderLaborRate":{
            "title":"Hourly Rate",
            "type":"number",
            "description":"Value for the hourly labor rate for the provider.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Object ID",
            "type":"integer",
            "description":"Value that uniquely identifies the the object for which the claim was created.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PrimaryReasonForRepairCode":{
            "title":"Primary Reason for Repair Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order operation reason for repair code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimResolutionDate":{
            "title":"Claim Resolution Date",
            "type":"string",
            "description":"Resolution Date of the warranty claim. This value is optional.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "description":"Value that uniquely identifies the work order associated to the warranty claim. This attribute is read-only.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ClaimStatus":{
            "title":"Claim Status",
            "maxLength":"80",
            "type":"string",
            "description":"Status of a warranty claim.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimCurrencyConversionRate":{
            "title":"Currency Conversion Rate",
            "type":"number",
            "description":"Rate of a claim currency converstion.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the record was updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

This example describes how to get all warranty claims.

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

Example Response Body

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

{
    "items": [
        {
            "ClaimId": 100101576542076,
            "ClaimNumber": "100101576542076",
            "ClaimDate": "2023-04-04",
            "ObjectTypeCode": "ORA_WORK_ORDER",
            "ObjectType": "Work order",
            "ObjectId": 300100582281486,
            "ClaimStatusCode": "ORA_PENDING_REVIEW",
            "ClaimStatus": "Pending review",
            "ClaimTypeCode": null,
            "ClaimType": null,
            "ManuallyCreatedFlag": false,
            "WorkOrderNumber": "MNTALM1108",
            "WorkOrderStatusCode": "ORA_COMPLETED",
            "WorkOrderStatus": "Completed",
            "OrganizationId": 300100113363336,
            "OrganizationCode": "MNTALM",
            "AssetId": 300100570947822,
            "AssetNumber": "ALM_ASSET_001",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": null,
            "RootAssetId": 300100570947822,
            "MatchToTransactionCodeFlag": true,
            "PrimaryReasonForRepairCode": null,
            "PrimaryReasonForRepairName": null,
            "WarrantyProviderId": 999992000322154,
            "WarrantyProviderNumber": "7189",
            "WarrantyProviderName": "General Technologies",
            "WarrantyProviderLaborRate": 0,
            "ClaimSubmitByNumberOfDays": 90,
            "ClaimSubmitByDate": null,
            "ClaimAssignedId": null,
            "ClaimAssignedToName": null,
            "WorkOrderMaterialCost": 0,
            "WorkOrderLaborCost": 0,
            "WorkOrderEquipmentCost": 0,
            "WorkOrderTotalCost": 0,
            "ClaimMaterialAmount": null,
            "ClaimResourceAmount": null,
            "ClaimEquipmentAmount": null,
            "ClaimStandardRepairAmount": 0,
            "ClaimOtherAmount": 0,
            "ClaimAdjustmentAmount": 0,
            "ClaimTotalAmount": 0,
            "ClaimCurrencyCode": "USD",
            "ClaimCurrency": "US Dollar",
            "ClaimDescription": "MNTALM1108:",
            "ClaimResolutionDate": null,
            "ClaimReference": null,
            "ClaimReimbursementTypeCode": null,
            "ClaimReimbursementType": null,
            "ClaimReimbursementAmount": 0,
            "ClaimCurrencyConversionTypeCode": null,
            "ClaimCurrencyConversionType": null,
            "ClaimCurrencyConversionRate": null,
            "ClaimNotes": "MNTALM1108",
            "ActiveEndDate": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-04-04T15:05:16+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-04-04T15:05:16+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/assetWarrantyClaims/100101576542076",
                    "name": "assetWarrantyClaims",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/assetWarrantyClaims/100101576542076",
                    "name": "assetWarrantyClaims",
                    "kind": "item"
                }
            ]
        },
        {
            "ClaimId": 100101576542076,
            "ClaimNumber": "100101576542076",
            "ClaimDate": "2023-04-04",
            "ObjectTypeCode": "ORA_WORK_ORDER",
            "ObjectType": "Work order",
            "ObjectId": 300100582281486,
            "ClaimStatusCode": "ORA_PENDING_REVIEW",
            "ClaimStatus": "Pending review",
            "ClaimTypeCode": null,
            "ClaimType": null,
            "ManuallyCreatedFlag": false,
            "WorkOrderNumber": "MNTALM1108",
            "WorkOrderStatusCode": "ORA_COMPLETED",
            "WorkOrderStatus": "Completed",
            "OrganizationId": 300100113363336,
            "OrganizationCode": "MNTALM",
            "AssetId": 300100570947822,
            "AssetNumber": "ALM_ASSET_001",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": null,
            "RootAssetId": 300100570947822,
            "MatchToTransactionCodeFlag": true,
            "PrimaryReasonForRepairCode": null,
            "PrimaryReasonForRepairName": null,
            "WarrantyProviderId": 999992000322154,
            "WarrantyProviderNumber": "7189",
            "WarrantyProviderName": "General Technologies",
            "WarrantyProviderLaborRate": 0,
            "ClaimSubmitByNumberOfDays": 180,
            "ClaimSubmitByDate": null,
            "ClaimAssignedId": null,
            "ClaimAssignedToName": null,
            "WorkOrderMaterialCost": 0,
            "WorkOrderLaborCost": 0,
            "WorkOrderEquipmentCost": 0,
            "WorkOrderTotalCost": 0,
            "ClaimMaterialAmount": null,
            "ClaimResourceAmount": null,
            "ClaimEquipmentAmount": null,
            "ClaimStandardRepairAmount": 0,
            "ClaimOtherAmount": 0,
            "ClaimAdjustmentAmount": 0,
            "ClaimTotalAmount": 0,
            "ClaimCurrencyCode": "USD",
            "ClaimCurrency": "US Dollar",
            "ClaimDescription": "MNTALM1108:",
            "ClaimResolutionDate": null,
            "ClaimReference": null,
            "ClaimReimbursementTypeCode": null,
            "ClaimReimbursementType": null,
            "ClaimReimbursementAmount": 0,
            "ClaimCurrencyConversionTypeCode": null,
            "ClaimCurrencyConversionType": null,
            "ClaimCurrencyConversionRate": null,
            "ClaimNotes": "MNTALM1108",
            "ActiveEndDate": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-04-04T15:05:16+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-04-04T15:05:16+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version5/assetWarrantyClaims/100101576542076",
                    "name": "assetWarrantyClaims",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version5/assetWarrantyClaims/100101576542076",
                    "name": "assetWarrantyClaims",
                    "kind": "item"
                }
            ]
        }
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version5/assetWarrantyClaims",
            "name": "assetWarrantyClaims",
            "kind": "collection"
        }
    ]
}

Back to Top