Get one entitlement
get
/fscmRestApi/resources/11.13.18.05/assetWarrantyEntitlements/{EntitlementId}
Request
Path Parameters
-
EntitlementId(required): integer(int64)
Value that uniquely identifies the warranty entitlement for a maintenance work order transaction.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : assetWarrantyEntitlements-item-response
Type:
Show Source
object
-
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:
Number
Read Only:true
Maximum Length:80
Number that uniquely identifies an asset. -
AssetSerialNumber: string
Title:
Serial Number
Read Only:true
Maximum Length:80
Serial number of the asset. -
ClaimId: integer
(int64)
Value that uniquely identifies the warranty claim. Either Claim ID or Claim Number can be defined.
-
ClaimNumber: string
Maximum Length:
255
Number that uniquely identifies the warranty claim. Either Claim ID or Claim Number can be defined. -
ContractId: integer
(int64)
Title:
Contract ID
Value that uniquely identifies the warranty contract. Either Contract ID or Contract Number can be defined. -
ContractNumber: string
Maximum Length:
255
Number that uniquely identifies the warranty contract. Either Contract ID or Contract Number can be defined. -
CostTransactionCurrency: string
Title:
Cost Transaction Currency
Read Only:true
Maximum Length:255
Abbreviation that uniquely identifies the currency for the cost transaction quantity. -
CostTransactionCurrencyCode: string
Title:
Cost Transaction Currency Code
Read Only:true
Maximum Length:20
Abbreviation that uniquely identifies the currency for the cost transaction quantity. This value is read-only. -
CostTransactionId: integer
(int64)
Title:
Cost Transaction ID
Read Only:true
Value that uniquely identifies the cost transaction for the Work Order Operations resource or for material transaction. -
CostTransactionQuantity: number
Title:
Cost Transaction Qty
Read Only:true
Cost transaction quantity. This value is read-only. -
CostTransactionTotal: integer
(int64)
Title:
Cost Transaction Total Cost
Read Only:true
Total cost of the cost transaction quantity. This value is read-only. -
CostTransactionType: string
Title:
Cost Transaction Type
Read Only:true
Maximum Length:80
Meaning of the cost transaction type code. -
CostTransactionTypeCode: string
Title:
Cost Transaction Type Code
Read Only:true
Maximum Length:30
Abbreviation that uniquely identifies the cost transaction type code. This value is read-only. -
CostTransactionUnitCost: number
Title:
Cost Transaction Unit Cost
Read Only:true
Unit cost of the cost transaction quantity. This value is read-only. -
CostTransactionUOM: string
Title:
Cost Transaction Unit of Measure
Read Only:true
Maximum Length:255
Value that indicates the description for the Cost Transaction UOM Code. This value is read-only. -
CostTransactionUOMCode: string
Title:
Unit of Measure Code
Read Only:true
Maximum Length:3
Unit of measure for the cost transaction quantity. This value is read-only. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
Login username of the user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
Date when the record was created. -
EntitlementDate: string
(date)
Title:
Entitlement Date
Creation date of the entitlement. -
EntitlementDescription: string
Maximum Length:
240
Description of the warranty entitlement. -
EntitlementId: integer
(int64)
Title:
Entitlement ID
Value that uniquely identifies the warranty entitlement for a maintenance work order transaction. -
EntitlementNotes: string
Title:
Entitlement Note
Maximum Length:4000
Notes of the warranty entitlement. -
EntitlementNumber: string
Title:
Entitlement Number
Maximum Length:80
Value of the warranty entitlement. -
EntitlementType: string
Title:
Entitlement Type
Read Only:true
Maximum Length:80
Name of the type of entitlement. -
EntitlementTypeCode: string
Title:
Entitlement Type Code
Maximum Length:30
Default Value:ORA_OTHER
Abbreviation that uniquely identifies the type of entitlement. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
Date when the record was updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
Login username 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
Read Only:true
Maximum Length:1
Default Value:true
Indicates if an entitlement is manually created or not. -
OperationName: string
Title:
Work Order Operation Name
Read Only:true
Maximum Length:120
Name of a maintenance work order operation. This value is read-only. -
OperationSequenceNumber: number
Title:
Operation Sequence
Read Only:true
Number that uniquely identifies a maintenance work order operation. This value is read-only. -
OrganizationCode: string
Read Only:
true
Maximum Length:18
Abbreviation that uniquely identifies the organization for the entitlement. Either Organization ID or Code is required. -
OrganizationId: integer
(int64)
Title:
Organization ID
Abbreviation that uniquely identifies the inventory organization for the entitlement. -
ReasonForRepairCode: string
Title:
Repair Transaction Code
Maximum Length:80
Abbreviation that uniquely identifies the work order operation reason for repair code. -
ReasonForRepairCodeName: string
Title:
Reason for Repair
Read Only:true
Maximum Length:240
Name of the work order operation reason for repair code. -
ReimbursementCurrency: string
Title:
Reimbursement Currency
Read Only:true
Maximum Length:255
Meaning of the reimbursement currency code. This value is read-only. -
ReimbursementCurrencyCode: string
Title:
Reimbursement Currency Code
Maximum Length:20
Abbreviation that uniquely identifies the currency code of the reimbursement total cost. -
ReimbursementQuantity: number
Title:
Reimbursement Quantity
Default Value:0
Quantity to be reimbursed on a warranty claim. -
ReimbursementQuantityUOM: string
Title:
Reimbursement Quantity Unit of Measure
Read Only:true
Maximum Length:120
Unit of measure for the quantity to be reimbursed on a warranty claim. -
ReimbursementQuantityUOMCode: string
Title:
Unit of Measure Code
Maximum Length:3
Abbreviation that uniquely identifies the unit of measure for the quantity to be reimbursed on a warranty claim. -
ReimbursementTotalCost: number
Title:
Reimbursement Total Cost
Read Only:true
Total cost to be reimbursed on a warranty claim. -
ReimbursementUnitCost: number
Title:
Reimbursement Unit Cost
Default Value:0
Unit cost of each quantity to be reimbursed on a warranty claim. -
RootAssetId: integer
(int64)
Read Only:
true
Value that uniquely identifies the root asset. -
TransactionCode: string
Title:
Transaction Code
Maximum Length:80
Abbreviation that uniquely identifies the work order operation transaction code. -
TransactionCodeName: string
Title:
Transaction Code Name
Read Only:true
Maximum Length:540
Name of the work order operation transaction code. -
WarrantyEntitledFlag: boolean
Title:
Warranty Entitled Indicator
Read Only:true
Maximum Length:1
Indicates if an entitlement is covered by warranty or not. -
WarrantyProviderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the warranty provider. -
WarrantyProviderName: string
Title:
Warranty Provider Name
Read Only:true
Maximum Length:255
Name of the warranty provider. -
WarrantyProviderNumber: string
Title:
Warranty Provider Number
Read Only:true
Maximum Length:255
Number for the supplier that is the warranty provider. -
WoOperationId: integer
(int64)
Title:
Work Order Operation ID
Value that uniquely identifies a maintenance work order operation. -
WoOperationMaterialId: integer
(int64)
Title:
Work Order Material ID
Read Only:true
Value that uniquely identifies a maintenance work-order operation material transaction. -
WoOperationReference: string
Title:
Work Order Operation Reference
Read Only:true
Maximum Length:255
Value that uniquely identifies a maintenance work order operation sequence. -
WoOperationResourceId: integer
(int64)
Title:
Work Order Resource ID
Read Only:true
Value that uniquely identifies a maintenance work-order operation resource transaction. -
WorkAccomplishedCode: string
Maximum Length:
80
Abbreviation that uniquely identifies the work order operation work accomplished code. -
WorkAccomplishedCodeName: string
Title:
Work to Be Accomplished
Read Only:true
Maximum Length:240
Abbreviation that uniquely identifies the work order operation work accomplished code. -
WorkOrderId: integer
(int64)
Title:
Work Order ID
Value that uniquely identifies a maintenance work order. -
WorkOrderNumber: string
Title:
Work Order
Read Only:true
Maximum Length:120
Number of a maintenance work order. This value is read-only.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Examples
This example describes how to get one warranty entitlement.
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/assetWarrantyEntitlements/EntitlementId"
For example:
curl -u username:password "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/300100582777631"
Example 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" } ] }