Jump to

• Request
• Response
• Examples

Get all entitlements

get

/fscmRestApi/resources/11.13.18.05/assetWarrantyEntitlements

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 entitlements according to the entitlement identifier.
    Finder Variables:
    • EntitlementId; integer; Value that uniquely identifies an entitlement.
• 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:
  

  • 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.
  • ClaimId; integer; Value that uniquely identifies the warranty claim. Either Claim ID or Claim Number can be defined.
  • ClaimNumber; string; Number that uniquely identifies the warranty claim. Either Claim ID or Claim Number can be defined.
  • ContractId; integer; Value that uniquely identifies the warranty contract. Either Contract ID or Contract Number can be defined.
  • ContractNumber; string; Number that uniquely identifies the warranty contract. Either Contract ID or Contract Number can be defined.
  • CostTransactionCurrency; string; Abbreviation that uniquely identifies the currency for the cost transaction quantity.
  • CostTransactionCurrencyCode; string; Abbreviation that uniquely identifies the currency for the cost transaction quantity. This value is read-only.
  • CostTransactionId; integer; Value that uniquely identifies the cost transaction for the Work Order Operations resource or for material transaction.
  • CostTransactionQuantity; number; Cost transaction quantity. This value is read-only.
  • CostTransactionType; string; Meaning of the cost transaction type code.
  • CostTransactionTypeCode; string; Abbreviation that uniquely identifies the cost transaction type code. This value is read-only.
  • CostTransactionUOM; string; Value that indicates the description for the Cost Transaction UOM Code. This value is read-only.
  • CostTransactionUOMCode; string; Unit of measure for the cost transaction quantity. This value is read-only.
  • CostTransactionUnitCost; number; Unit cost of the cost transaction quantity. This value is read-only.
  • CreatedBy; string; Login username of the user who created the record.
  • CreationDate; string; Date when the record was created.
  • EntitlementDate; string; Creation date of the entitlement.
  • EntitlementDescription; string; Description of the warranty entitlement.
  • EntitlementId; integer; Value that uniquely identifies the warranty entitlement for a maintenance work order transaction.
  • EntitlementNotes; string; Notes of the warranty entitlement.
  • EntitlementNumber; string; Value of the warranty entitlement.
  • EntitlementType; string; Name of the type of entitlement.
  • EntitlementTypeCode; string; Abbreviation that uniquely identifies the type of entitlement.
  • LastUpdateDate; string; Date when the record was updated.
  • LastUpdatedBy; string; Login username of the user who updated the record.
  • ManuallyCreatedFlag; boolean; Indicates if an entitlement is manually created or not.
  • OperationName; string; Name of a maintenance work order operation. This value is read-only.
  • OperationSequenceNumber; number; Number that uniquely identifies a maintenance work order operation. This value is read-only.
  • OrganizationCode; string; Abbreviation that uniquely identifies the organization for the entitlement. Either Organization ID or Code is required.
  • OrganizationId; integer; Abbreviation that uniquely identifies the inventory organization for the entitlement.
  • ReasonForRepairCode; string; Abbreviation that uniquely identifies the work order operation reason for repair code.
  • ReasonForRepairCodeId; integer; Value that uniquely identifies the work order operation reason for repair code.
  • ReasonForRepairCodeName; string; Name of the work order operation reason for repair code.
  • ReimbursementCurrencyCode; string; Abbreviation that uniquely identifies the currency code of the reimbursement total cost.
  • ReimbursementQuantity; number; Quantity to be reimbursed on a warranty claim.
  • ReimbursementQuantityUOM; string; Unit of measure for the quantity to be reimbursed on a warranty claim.
  • ReimbursementQuantityUOMCode; string; Abbreviation that uniquely identifies the unit of measure for the quantity to be reimbursed on a warranty claim.
  • ReimbursementTotalCost; number; Total cost to be reimbursed on a warranty claim.
  • ReimbursementUnitCost; number; Unit cost of each quantity to be reimbursed on a warranty claim.
  • RootAssetId; integer; Value that uniquely identifies the root asset.
  • TransactionCode; string; Abbreviation that uniquely identifies the work order operation transaction code.
  • TransactionCodeId; integer; Value that uniquely identifies the work order operation transaction code.
  • TransactionCodeName; string; Name of the work order operation transaction code.
  • WarrantyEntitledFlag; boolean; Indicates if an entitlement is covered by warranty or not.
  • WarrantyProviderId; integer; Value that uniquely identifies the warranty provider.
  • WarrantyProviderName; string; Name of the warranty provider.
  • WarrantyProviderNumber; string; Number for the supplier that is the warranty provider.
  • WoOperationId; integer; Value that uniquely identifies a maintenance work order operation.
  • WoOperationMaterialId; integer; Value that uniquely identifies a maintenance work-order operation material transaction.
  • WoOperationResourceId; integer; Value that uniquely identifies a maintenance work-order operation resource transaction.
  • WorkAccomplishedCode; string; Abbreviation that uniquely identifies the work order operation work accomplished code.
  • WorkAccomplishedCodeId; integer; Value that uniquely identifies the work order operation work accomplished code.
  • WorkAccomplishedCodeName; string; Abbreviation that uniquely identifies the work order operation work accomplished code.
  • WorkOrderId; integer; Value that uniquely identifies a maintenance work order.
  • WorkOrderNumber; string; Number of a maintenance work order. This value is read-only.
• 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 : assetWarrantyEntitlements

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/assetWarrantyEntitlements-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 assetWarrantyEntitlements-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/assetWarrantyEntitlements-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 : assetWarrantyEntitlements-item-response

Type: object

Show Source

• 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.
• ReasonForRepairCodeId: integer (int64)
  Value 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.
• TransactionCodeId: integer (int64)
  Title: Work Order Transaction ID

  Value 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.
• WorkAccomplishedCodeId: integer (int64)
  Value 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.

{
    "type":"object",
    "properties":{
        "TransactionCodeId":{
            "title":"Work Order Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation transaction code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReimbursementQuantity":{
            "title":"Reimbursement Quantity",
            "type":"number",
            "description":"Quantity to be reimbursed on a warranty claim.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "ReimbursementCurrencyCode":{
            "title":"Reimbursement Currency Code",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency code of the reimbursement total cost.",
            "nullable":true,
            "x-queryable":true
        },
        "CostTransactionCurrency":{
            "title":"Cost Transaction Currency",
            "maxLength":"255",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency for the cost transaction quantity.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the warranty contract. Either Contract ID or Contract Number can be defined.",
            "nullable":true,
            "x-queryable":true
        },
        "CostTransactionCurrencyCode":{
            "title":"Cost Transaction Currency Code",
            "maxLength":"20",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the currency for the cost transaction quantity. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetDescription":{
            "title":"Asset Description",
            "maxLength":"240",
            "type":"string",
            "description":"Description of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementId":{
            "title":"Entitlement ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty entitlement for a maintenance work order transaction.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "EntitlementDescription":{
            "maxLength":"240",
            "type":"string",
            "description":"Description of the warranty entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetNumber":{
            "title":"Number",
            "maxLength":"80",
            "type":"string",
            "description":"Number that uniquely identifies an asset.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionType":{
            "title":"Cost Transaction Type",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the cost transaction type code.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementNotes":{
            "title":"Entitlement Note",
            "maxLength":"4000",
            "type":"string",
            "description":"Notes of the warranty entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCode":{
            "title":"Transaction Code",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order operation transaction code.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReimbursementQuantityUOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":"3",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the unit of measure for the quantity to be reimbursed on a warranty claim.",
            "nullable":true,
            "x-queryable":true
        },
        "TransactionCodeName":{
            "title":"Transaction Code Name",
            "maxLength":"540",
            "type":"string",
            "description":"Name of the work order operation transaction code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionUOMCode":{
            "title":"Unit of Measure Code",
            "maxLength":"3",
            "type":"string",
            "description":"Unit of measure for the cost transaction quantity. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"Login username of the user who updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"Login username of the user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WoOperationResourceId":{
            "title":"Work Order Resource ID",
            "type":"integer",
            "description":"Value that uniquely identifies a maintenance work-order operation resource transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CostTransactionTotal":{
            "title":"Cost Transaction Total Cost",
            "type":"integer",
            "description":"Total cost of the cost transaction quantity. This value is read-only.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"255"
            }
        },
        "WarrantyProviderName":{
            "title":"Warranty Provider Name",
            "maxLength":"255",
            "type":"string",
            "description":"Name of the warranty provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkAccomplishedCodeName":{
            "title":"Work to Be Accomplished",
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order operation work accomplished code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyProviderNumber":{
            "title":"Warranty Provider Number",
            "maxLength":"255",
            "type":"string",
            "description":"Number for the supplier that is the warranty provider.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetSerialNumber":{
            "title":"Serial Number",
            "maxLength":"80",
            "type":"string",
            "description":"Serial number of the asset.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderNumber":{
            "title":"Work Order",
            "maxLength":"120",
            "type":"string",
            "description":"Number of a maintenance work order. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionId":{
            "title":"Cost Transaction ID",
            "type":"integer",
            "description":"Value that uniquely identifies the cost transaction for the Work Order Operations resource or for material transaction.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAccomplishedCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order operation work accomplished code.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationSequenceNumber":{
            "title":"Operation Sequence",
            "type":"number",
            "description":"Number that uniquely identifies a maintenance work order operation. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyProviderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the warranty provider.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetId":{
            "title":"Asset ID",
            "type":"integer",
            "description":"Value that uniquely identifies an asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WorkAccomplishedCodeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation work accomplished code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonForRepairCode":{
            "title":"Repair Transaction Code",
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the work order operation reason for repair code.",
            "nullable":true,
            "x-queryable":true
        },
        "ClaimId":{
            "type":"integer",
            "description":"Value that uniquely identifies the warranty claim. Either Claim ID or Claim Number can be defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReasonForRepairCodeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the work order operation reason for repair code.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationMaterialId":{
            "title":"Work Order Material ID",
            "type":"integer",
            "description":"Value that uniquely identifies a maintenance work-order operation material transaction.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReimbursementUnitCost":{
            "title":"Reimbursement Unit Cost",
            "type":"number",
            "description":"Unit cost of each quantity to be reimbursed on a warranty claim.",
            "nullable":true,
            "default":"0",
            "x-queryable":true
        },
        "EntitlementNumber":{
            "title":"Entitlement Number",
            "maxLength":"80",
            "type":"string",
            "description":"Value of the warranty entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "title":"Organization ID",
            "type":"integer",
            "description":"Abbreviation that uniquely identifies the inventory organization for the entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "RootAssetId":{
            "type":"integer",
            "description":"Value that uniquely identifies the root asset.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ReimbursementQuantityUOM":{
            "title":"Reimbursement Quantity Unit of Measure",
            "maxLength":"120",
            "type":"string",
            "description":"Unit of measure for the quantity to be reimbursed on a warranty claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ManuallyCreatedFlag":{
            "title":"Manually Created Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an entitlement is manually created or not.",
            "nullable":true,
            "readOnly":true,
            "default":true,
            "x-queryable":true
        },
        "CostTransactionTypeCode":{
            "title":"Cost Transaction Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the cost transaction type code. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":"18",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the organization for the entitlement. Either Organization ID or Code is required.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementType":{
            "title":"Entitlement Type",
            "maxLength":"80",
            "type":"string",
            "description":"Name of the type of entitlement.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionQuantity":{
            "title":"Cost Transaction Qty",
            "type":"number",
            "description":"Cost transaction quantity. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionUnitCost":{
            "title":"Cost Transaction Unit Cost",
            "type":"number",
            "description":"Unit cost of the cost transaction quantity. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ClaimNumber":{
            "maxLength":"255",
            "type":"string",
            "description":"Number that uniquely identifies the warranty claim. Either Claim ID or Claim Number can be defined.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Work Order Operation Name",
            "maxLength":"120",
            "type":"string",
            "description":"Name of a maintenance work order operation. This value is read-only.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CostTransactionUOM":{
            "title":"Cost Transaction Unit of Measure",
            "maxLength":"255",
            "type":"string",
            "description":"Value that indicates the description for the Cost Transaction UOM Code. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ContractId":{
            "title":"Contract ID",
            "type":"integer",
            "description":"Value that uniquely identifies the warranty contract. Either Contract ID or Contract Number can be defined.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntitlementDate":{
            "title":"Entitlement Date",
            "type":"string",
            "description":"Creation date of the entitlement.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReimbursementCurrency":{
            "title":"Reimbursement Currency",
            "maxLength":"255",
            "type":"string",
            "description":"Meaning of the reimbursement currency code. This value is read-only.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReimbursementTotalCost":{
            "title":"Reimbursement Total Cost",
            "type":"number",
            "description":"Total cost to be reimbursed on a warranty claim.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WarrantyEntitledFlag":{
            "title":"Warranty Entitled Indicator",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates if an entitlement is covered by warranty or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "WorkOrderId":{
            "title":"Work Order ID",
            "type":"integer",
            "description":"Value that uniquely identifies a maintenance work order.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "WoOperationId":{
            "title":"Work Order Operation ID",
            "type":"integer",
            "description":"Value that uniquely identifies a maintenance work order operation.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntitlementTypeCode":{
            "title":"Entitlement Type Code",
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that uniquely identifies the type of entitlement.",
            "nullable":true,
            "default":"ORA_OTHER",
            "x-queryable":true
        },
        "WoOperationReference":{
            "title":"Work Order Operation Reference",
            "maxLength":"255",
            "type":"string",
            "description":"Value that uniquely identifies a maintenance work order operation sequence.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ReasonForRepairCodeName":{
            "title":"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
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "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 entitlements.

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"

Example Response Body

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

{
    "items": [
        {
            "EntitlementId": 100101576542833,
            "EntitlementNumber": "100101576542833",
            "EntitlementDate": "2023-04-04",
            "EntitlementTypeCode": "ORA_RESOURCE_CHARGE",
            "EntitlementType": "Resource charge",
            "EntitlementDescription": "M-Technician General - M-Technician General\n",
            "ClaimId": 100101576542836,
            "ClaimNumber": "100101576542836",
            "ManuallyCreatedFlag": false,
            "WarrantyEntitledFlag": true,
            "ContractId": 300100578221096,
            "ContractNumber": "300100578221096",
            "WarrantyProviderId": "999992000322154",
            "WarrantyProviderNumber": "7189",
            "WarrantyProviderName": "General Technologies",
            "OrganizationId": 300100113363336,
            "OrganizationCode": "MNTALM",
            "WorkOrderId": 300100582281522,
            "WorkOrderNumber": "MNTALM1110",
            "AssetId": 300100570947822,
            "AssetNumber": "ALM_ASSET_001",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": null,
            "RootAssetId": 300100570947822,
            "WoOperationId": 300100582281533,
            "OperationSequenceNumber": 40,
            "OperationName": "RD_STD_OP1",
            "WoOperationResourceId": 300100582281534,
            "WoOperationReference": "MNTALM1110-40",
            "WoOperationMaterialId": null,
            "CostTransactionId": 100101576542832,
            "ReasonForRepairCode": "01",
            "ReasonForRepairCodeName": "Breakdown",
            "TransactionCode": "013-000-000",
            "TransactionCodeName": "Brakes000",
            "WorkAccomplishedCode": "W-CODE",
            "WorkAccomplishedCodeName": "Work Done Na,e",
            "CostTransactionTypeCode": "ORA_RESOURCE",
            "CostTransactionType": "Resource",
            "CostTransactionQuantity": 1,
            "CostTransactionUOMCode": "HRS",
            "CostTransactionUOM": "HRS",
            "CostTransactionUnitCost": null,
            "CostTransactionTotal": null,
            "CostTransactionCurrencyCode": null,
            "CostTransactionCurrency": null,
            "ReimbursementQuantity": 1,
            "ReimbursementQuantityUOMCode": "HRS",
            "ReimbursementQuantityUOM": "HRS",
            "ReimbursementUnitCost": 0,
            "ReimbursementTotalCost": 0,
            "ReimbursementCurrencyCode": null,
            "ReimbursementCurrency": null,
            "EntitlementNotes": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-04-04T15:26:54+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-04-04T15:26:54+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/100101576542833",
                    "name": "assetWarrantyEntitlements",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/100101576542833",
                    "name": "assetWarrantyEntitlements",
                    "kind": "item"
                }
            ]
        },
        {
            "EntitlementId": 100101576542835,
            "EntitlementNumber": "100101576542835",
            "EntitlementDate": "2023-04-04",
            "EntitlementTypeCode": "ORA_RESOURCE_CHARGE",
            "EntitlementType": "Resource charge",
            "EntitlementDescription": "LaborRes-10 - ",
            "ClaimId": 100101576542836,
            "ClaimNumber": "100101576542836",
            "ManuallyCreatedFlag": false,
            "WarrantyEntitledFlag": true,
            "ContractId": 300100578221096,
            "ContractNumber": "300100578221096",
            "WarrantyProviderId": "999992000322154",
            "WarrantyProviderNumber": "7189",
            "WarrantyProviderName": "General Technologies",
            "OrganizationId": 300100113363336,
            "OrganizationCode": "MNTALM",
            "WorkOrderId": 300100582281522,
            "WorkOrderNumber": "MNTALM1110",
            "AssetId": 300100570947822,
            "AssetNumber": "ALM_ASSET_001",
            "AssetDescription": "ALM-MX-ITEM-001-DESC",
            "AssetSerialNumber": null,
            "RootAssetId": 300100570947822,
            "WoOperationId": 300100582281530,
            "OperationSequenceNumber": 30,
            "OperationName": "Replace Power Supply Unit",
            "WoOperationResourceId": 300100582281531,
            "WoOperationReference": "MNTALM1110-30",
            "WoOperationMaterialId": null,
            "CostTransactionId": 100101576542834,
            "ReasonForRepairCode": "01",
            "ReasonForRepairCodeName": "Breakdown",
            "TransactionCode": "013-000-000",
            "TransactionCodeName": "Brakes000",
            "WorkAccomplishedCode": "W-CODE",
            "WorkAccomplishedCodeName": "Work Done Na,e",
            "CostTransactionTypeCode": "ORA_RESOURCE",
            "CostTransactionType": "Resource",
            "CostTransactionQuantity": 1,
            "CostTransactionUOMCode": "HR",
            "CostTransactionUOM": "Hour",
            "CostTransactionUnitCost": null,
            "CostTransactionTotal": null,
            "CostTransactionCurrencyCode": null,
            "CostTransactionCurrency": null,
            "ReimbursementQuantity": 1,
            "ReimbursementQuantityUOMCode": "HR",
            "ReimbursementQuantityUOM": "Hour",
            "ReimbursementUnitCost": 0,
            "ReimbursementTotalCost": 0,
            "ReimbursementCurrencyCode": null,
            "ReimbursementCurrency": null,
            "EntitlementNotes": null,
            "CreatedBy": "MNT_QA",
            "CreationDate": "2023-04-04T15:26:54+00:00",
            "LastUpdatedBy": "MNT_QA",
            "LastUpdateDate": "2023-04-04T15:26:54+00:00",
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/100101576542835",
                    "name": "assetWarrantyEntitlements",
                    "kind": "item",
                    "properties": {
                        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
                    }
                },
                {
                    "rel": "canonical",
                    "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements/100101576542835",
                    "name": "assetWarrantyEntitlements",
                    "kind": "item"
                }
            ]
        },
    "count": 2,
    "hasMore": false,
    "limit": 25,
    "offset": 0,
    "links": [
        {
            "rel": "self",
            "href": "https://servername/fscmRestApi/resources/version/assetWarrantyEntitlements",
            "name": "assetWarrantyEntitlements",
            "kind": "collection"
        }
    ]
}

Back to Top