Jump to

• Request
• Response

Create a subscription entitlement

post

/crmRestApi/resources/11.13.18.05/entitlements

Request

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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• AssetId: integer (int64)
  The unique identifier of the covered asset.
• ChannelCode: string
  Maximum Length: 120

  The code for the service request channel.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account.
• CustomerPartyId: integer (int64)
  The unique identifier of the customer party.
• entitlementDetails: array Entitlement Details
  Title: Entitlement Details

  The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.
• EntitlementsInputId: integer (int64)
  The unique identifier of the entitlement input.
• EntitlementsInputPuid: string
  Maximum Length: 120

  The public unique identifier of the entitlements input.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• PartyContactId: integer (int64)
  The unique identifier of the party contact.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartySiteId: integer (int64)
  The unique identifier of the party site.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• ServiceRequestId(required): integer (int64)
  The unique identifier of the service request.
• ServiceRequestReportedDate(required): string (date)
  The date the service request was reported.
• SeverityCode: string
  Maximum Length: 120

  The code for the service request severity.

{
    "required":[
        "ServiceRequestId",
        "ServiceRequestReportedDate"
    ],
    "type":"object",
    "properties":{
        "EntitlementsInputPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the entitlements input.",
            "nullable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ChannelCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The code for the service request channel.",
            "nullable":true
        },
        "CustomerPartyId":{
            "type":"integer",
            "description":"The unique identifier of the customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartyContactId":{
            "type":"integer",
            "description":"The unique identifier of the party contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ServiceRequestId":{
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "entitlementDetails":{
            "title":"Entitlement Details",
            "type":"array",
            "description":"The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-item-post-request"
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EntitlementsInputId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement input.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "SeverityCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The code for the service request severity.",
            "nullable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ServiceRequestReportedDate":{
            "type":"string",
            "description":"The date the service request was reported.",
            "format":"date",
            "nullable":false
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : Entitlement Details

Type: array

Title: Entitlement Details

The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.

Show Source

• Array of: object entitlements-entitlementDetails-item-post-request

{
    "title":"Entitlement Details",
    "type":"array",
    "description":"The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-item-post-request"
    }
}

Nested Schema : entitlements-entitlementDetails-item-post-request

Type: object

Show Source

• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• ChannelCode: string
  Maximum Length: 120

  The channel code associated with the service request.
• chargeAdjustments: array Adjustments
  Title: Adjustments

  The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.
• CoverageDescription: string
  Maximum Length: 1000

  The description of the coverage.
• CoverageId: integer (int64)
  The unique identifier of the coverage.
• CoverageLineNumber: string
  Maximum Length: 120

  The line number of the associated coverage.
• CoverageName: string
  Maximum Length: 150

  The name of the coverage.
• CoverageProductDescription: string
  Maximum Length: 120

  The description of the product coverage.
• CoverageProductId: integer (int64)
  The unique identifier of the coverage product.
• CoverageProductName: string
  Maximum Length: 120

  The name of the product associated with the coverage.
• CoverageProductPuid: string
  Maximum Length: 120

  The public unique identifier of the coverage product.
• CoveragePuid: string
  Maximum Length: 120

  The public unique identifier of the coverage.
• CoveredAssetClosedDate: string (date)
  The subscription product association product close date.
• CoveredAssetEndDate: string (date)
  The end date of the covered asset.
• CoveredAssetId: integer (int64)
  The unique identifier of the covered asset.
• CoveredAssetLinenum: string
  Maximum Length: 300

  The line number of the associated coverage asset.
• CoveredAssetProdDescription: string
  Maximum Length: 320

  The description of the product associated with the covered asset.
• CoveredAssetProdName: string
  Maximum Length: 200

  The name of the product associated with the covered asset.
• CoveredAssetStartDate: string (date)
  The start date of the covered asset.
• CoveredInventoryItemId: integer (int64)
  The unique identifier of the covered inventory item.
• CoveredLevelCode: string
  Maximum Length: 30

  The code representing the covered level.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CoveredLevelName: string
  Maximum Length: 660

  The name of the covered level.
• CoveredLevelNumber: string
  Maximum Length: 100

  The number of the covered level.
• CoveredLevelPuid: string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account.
• CustomerPartyName: string
  Maximum Length: 120

  The name of the associated customer party.
• EndDate: string (date)
  The end date of the coverage.
• entitlementResults: array entitlementResults
• EntitlementsId: integer (int64)
  The unique identifier of the subscriptions entitlement.
• EntitlementsInputId(required): integer (int64)
  The unique identifier of the entitlements input.
• EntitlementsResultId: integer (int64)
  The unique identifier of the entitlements result.
• EntitlementsRuleId: integer (int64)
  The unique identifier of the entitlements rule.
• EntitlementsSource: string
  Maximum Length: 120

  The source of the entitlement.
• EntitlementsSourceCode: string
  Maximum Length: 120

  The source code of the entitlements.
• IsSubscriptionEntitled: string
  Maximum Length: 1

  Indicates if the subscription is entitled.
• MatrixId: integer (int64)
  The unique identifier of the coverage matrix.
• Message: string
  Maximum Length: 320

  The message associated with the entitlement.
• PartyContactId: integer (int64)
  The unique identifier of the party contact.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartySiteId: integer (int64)
  The unique identifier of the party site.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• RuleEndDate: string (date)
  The end date of the entitlement rule.
• RuleStartDate: string (date)
  The start date of the entitlement rules.
• SerialNumber: string
  Maximum Length: 80

  The serial number of the entitlement.
• ServiceRequestId: integer (int64)
  The unique identifier of the service request.
• SeverityCode: string
  Maximum Length: 120

  The code associated with the severity of the entitlement.
• StartDate: string (date)
  The start date of the coverage.
• subscriptionCoverageHeader: array Standard Coverages
  Title: Standard Coverages

  The standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Maximum Length: 120

  The alternate unique identifier of the subscription.

{
    "required":[
        "EntitlementsInputId"
    ],
    "type":"object",
    "properties":{
        "RuleEndDate":{
            "type":"string",
            "description":"The end date of the entitlement rule.",
            "format":"date",
            "nullable":true
        },
        "EntitlementsSourceCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The source code of the entitlements.",
            "nullable":true
        },
        "CoverageDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the coverage.",
            "nullable":true
        },
        "CoveredLevelNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"The number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the coverage.",
            "format":"date",
            "nullable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoveredAssetStartDate":{
            "type":"string",
            "description":"The start date of the covered asset.",
            "format":"date",
            "nullable":true
        },
        "CoveredLevelName":{
            "maxLength":"660",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementsSource":{
            "maxLength":"120",
            "type":"string",
            "description":"The source of the entitlement.",
            "nullable":true
        },
        "CoveredAssetLinenum":{
            "maxLength":"300",
            "type":"string",
            "description":"The line number of the associated coverage asset.",
            "nullable":true
        },
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the entitlement.",
            "nullable":true
        },
        "SeverityCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The code associated with the severity of the entitlement.",
            "nullable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"The unique identifier of the coverage matrix.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerPartyName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the associated customer party.",
            "nullable":true
        },
        "EntitlementsId":{
            "type":"integer",
            "description":"The unique identifier of the subscriptions entitlement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "Message":{
            "maxLength":"320",
            "type":"string",
            "description":"The message associated with the entitlement.",
            "nullable":true
        },
        "IsSubscriptionEntitled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the subscription is entitled.",
            "nullable":true
        },
        "CoverageName":{
            "maxLength":"150",
            "type":"string",
            "description":"The name of the coverage.",
            "nullable":true
        },
        "ChannelCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The channel code associated with the service request.",
            "nullable":true
        },
        "CoverageProductName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the product associated with the coverage.",
            "nullable":true
        },
        "CoveredLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code representing the covered level.",
            "nullable":true
        },
        "CoveredAssetClosedDate":{
            "type":"string",
            "description":"The subscription product association product close date.",
            "format":"date",
            "nullable":true
        },
        "CoveredInventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the covered inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EntitlementsRuleId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoveredLevelPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":true
        },
        "subscriptionCoverageHeader":{
            "title":"Standard Coverages",
            "type":"array",
            "description":"The standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-subscriptionCoverageHeader-item-post-request"
            }
        },
        "CoverageId":{
            "type":"integer",
            "description":"The unique identifier of the coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoveredAssetProdName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the product associated with the covered asset.",
            "nullable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "SubscriptionNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The alternate unique identifier of the subscription.",
            "nullable":true
        },
        "chargeAdjustments":{
            "title":"Adjustments",
            "type":"array",
            "description":"The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-chargeAdjustments-item-post-request"
            }
        },
        "entitlementResults":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-entitlementResults-item-post-request"
            }
        },
        "RuleStartDate":{
            "type":"string",
            "description":"The start date of the entitlement rules.",
            "format":"date",
            "nullable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the coverage.",
            "format":"date",
            "nullable":true
        },
        "PartyContactId":{
            "type":"integer",
            "description":"The unique identifier of the party contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "ServiceRequestId":{
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoveredAssetProdDescription":{
            "maxLength":"320",
            "type":"string",
            "description":"The description of the product associated with the covered asset.",
            "nullable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoveragePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the coverage.",
            "nullable":true
        },
        "EntitlementsInputId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements input.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoverageLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The line number of the associated coverage.",
            "nullable":true
        },
        "CoveredAssetEndDate":{
            "type":"string",
            "description":"The end date of the covered asset.",
            "format":"date",
            "nullable":true
        },
        "CoverageProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the coverage product.",
            "nullable":true
        },
        "EntitlementsResultId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements result.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoverageProductId":{
            "type":"integer",
            "description":"The unique identifier of the coverage product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "CoverageProductDescription":{
            "maxLength":"120",
            "type":"string",
            "description":"The description of the product coverage.",
            "nullable":true
        }
    }
}

Nested Schema : Adjustments

Type: array

Title: Adjustments

The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.

Show Source

• Array of: object entitlements-entitlementDetails-chargeAdjustments-item-post-request

{
    "title":"Adjustments",
    "type":"array",
    "description":"The adjustments resource is used to view, create, update, and delete an adjustment. It provides details of adjustment information.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-chargeAdjustments-item-post-request"
    }
}

Nested Schema : entitlementResults

Type: array

Show Source

• Array of: object entitlements-entitlementDetails-entitlementResults-item-post-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-entitlementResults-item-post-request"
    }
}

Nested Schema : Standard Coverages

Type: array

Title: Standard Coverages

The standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.

Show Source

• Array of: object entitlements-entitlementDetails-subscriptionCoverageHeader-item-post-request

{
    "title":"Standard Coverages",
    "type":"array",
    "description":"The standard coverage resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-subscriptionCoverageHeader-item-post-request"
    }
}

Nested Schema : entitlements-entitlementDetails-chargeAdjustments-item-post-request

Type: object

Show Source

• AdjustmentAmount: number
  Title: Value

  The value of the adjustment.
• AdjustmentTypeCode: string
  Maximum Length: 30

  The code associated with the adjustment type.
• AdjustmentTypeMeaning: string
  Title: Adjustment Type

  The description of the adjustment type.
• AllowCustomAdjustmentsFlag: boolean
  Title: Allow custom adjustments

  Maximum Length: 1

  Indicates whether custom adjustments are allowed. The Default value is True.
• AllowPricingDiscountsFlag: boolean
  Title: Allow pricing discounts

  Maximum Length: 1

  Indicates whether pricing discounts are allowed. The default value is False.
• BillingTypeCode: string
  Maximum Length: 30

  The code associated with the billing type.
• BillingTypeMeaning: string
  Title: Billing Type

  The description of the billing type.
• BusinessProcessCode: string
  Maximum Length: 30

  The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• BusinessProcessMeaning: string
  Title: Business Process

  The display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• ChargeDiscountId: integer (int64)
  The unique identifier of the charge discount.
• CoverageDiscountPuid: string
  Maximum Length: 120

  The value that uniquely identifies the adjustments.
• CoverageHeaderId: integer (int64)
  The unique identifier of the coverage header.
• EndDate: string (date)
  Title: End Date

  The end date of the adjustment.
• PricingBasisId: integer
  The unique identifier of the pricing basis.
• PricingBasisName: string
  Title: Adjustment Basis

  The name of the pricing basis.
• PricingTermId: integer
  The unique identifier of the pricing term.
• ServiceActivityId: integer (int64)
  The unique identifier of the service request.
• ServiceActivityName: string
  Title: Service Activity

  Maximum Length: 80

  The name of the service request.
• StartDate: string (date)
  Title: Start Date

  The start date of the adjustment.

{
    "type":"object",
    "properties":{
        "BillingTypeMeaning":{
            "title":"Billing Type",
            "type":"string",
            "description":"The description of the billing type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            }
        },
        "AdjustmentTypeMeaning":{
            "title":"Adjustment Type",
            "type":"string",
            "description":"The description of the adjustment type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "CoverageDiscountPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The value that uniquely identifies the adjustments.",
            "nullable":true
        },
        "PricingBasisName":{
            "title":"Adjustment Basis",
            "type":"string",
            "description":"The name of the pricing basis.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ChargeDiscountId":{
            "type":"integer",
            "description":"The unique identifier of the charge discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "BillingTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with the billing type.",
            "nullable":true
        },
        "BusinessProcessMeaning":{
            "title":"Business Process",
            "type":"string",
            "description":"The display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the adjustment.",
            "format":"date",
            "nullable":true
        },
        "PricingBasisId":{
            "type":"integer",
            "description":"The unique identifier of the pricing basis.",
            "nullable":true
        },
        "ServiceActivityName":{
            "title":"Service Activity",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the service request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with the adjustment type.",
            "nullable":false
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the adjustment.",
            "format":"date",
            "nullable":true
        },
        "ServiceActivityId":{
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AdjustmentAmount":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":false
        },
        "AllowPricingDiscountsFlag":{
            "title":"Allow pricing discounts",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether pricing discounts are allowed. The default value is False.",
            "nullable":true
        },
        "CoverageHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the coverage header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "AllowCustomAdjustmentsFlag":{
            "title":"Allow custom adjustments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether custom adjustments are allowed. The Default value is True.",
            "nullable":true
        },
        "BusinessProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true
        },
        "PricingTermId":{
            "type":"integer",
            "description":"The unique identifier of the pricing term.",
            "nullable":true
        }
    }
}

Nested Schema : entitlements-entitlementDetails-entitlementResults-item-post-request

Type: object

Show Source

• EntitlementsId: integer (int64)
  The unique identifier of the entailments.
• EntitlementsResultId: integer (int64)
  The unique identifier of the entitlements result.
• ObjectVersionNumber: integer (int32)
  The object version number for the entitlement.
• ResultName: string
  Maximum Length: 240

  The name of the result.
• ResultThresholdValue: string
  Maximum Length: 240

  The threshold value for the entitlement result.
• ResultValue: string
  Maximum Length: 240

  The value of the result.
• ScheduleId: integer (int64)
  The unique identifier of the schedule associated with the entitlement.

{
    "type":"object",
    "properties":{
        "ResultThresholdValue":{
            "maxLength":"240",
            "type":"string",
            "description":"The threshold value for the entitlement result.",
            "nullable":true
        },
        "ResultName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the result.",
            "nullable":true
        },
        "EntitlementsId":{
            "type":"integer",
            "description":"The unique identifier of the entailments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the entitlement.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            }
        },
        "EntitlementsResultId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "ResultValue":{
            "maxLength":"240",
            "type":"string",
            "description":"The value of the result.",
            "nullable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"The unique identifier of the schedule associated with the entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Nested Schema : entitlements-entitlementDetails-subscriptionCoverageHeader-item-post-request

Type: object

Show Source

• CoverageDescription: string
  Title: Template Description

  Maximum Length: 1000

  The value that uniquely identifies the standard coverage description.
• CoverageHeaderId: integer (int64)
  The unique identifier of the internal standard coverage.
• CoverageHeaderPuid: string
  Maximum Length: 120

  The value that uniquely identifies the standard coverage.
• CoverageName: string
  Title: Template Name

  Maximum Length: 150

  The name of the standard coverage.
• DynamicMatrixClassId: integer (int64)
  Title: Entitlement Type

  The unique identifier of the dynamic matrix class.
• DynamicMatrixClassName: string
  Title: Entitlement Type

  The alternate value that uniquely identifies the dynamic matrix class.
• EndDate: string (date)
  Title: End Date

  The date when the standard coverage ends.
• MatrixId: integer (int64)
  The unique identifier of the dynamic matrix.
• MatrixName: string
  The name of the matrix.
• ProgramCode: string
  Title: Program Code

  Maximum Length: 30

  The code of the associated maintenance program.
• ProgramId: integer (int64)
  The identifier of the associated maintenance program.
• ProgramName: string
  Title: Program Name

  Maximum Length: 120

  The name of the associated maintenance program.
• ProgramOrganizationId: integer (int64)
  Title: Organization

  The organization identifier of the associated maintenance program.
• StandardCoverageYn: string
  Maximum Length: 1

  Indicates whether coverage is standard coverage. The default value is False.
• StartDate: string (date)
  Title: Start Date

  The date when the adjustments was created.
• SubscriptionProductPuid: string
  The value that uniquely identifies the subscription product.

{
    "type":"object",
    "properties":{
        "DynamicMatrixClassId":{
            "title":"Entitlement Type",
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "StandardCoverageYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether coverage is standard coverage. The default value is False.",
            "nullable":true
        },
        "SubscriptionProductPuid":{
            "type":"string",
            "description":"The value that uniquely identifies the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "CoverageName":{
            "title":"Template Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the standard coverage.",
            "nullable":true
        },
        "CoverageDescription":{
            "title":"Template Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The value that uniquely identifies the standard coverage description.",
            "nullable":false
        },
        "MatrixName":{
            "type":"string",
            "description":"The name of the matrix.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProgramId":{
            "type":"integer",
            "description":"The identifier of the associated maintenance program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the standard coverage ends.",
            "format":"date",
            "nullable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the associated maintenance program.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            }
        },
        "ProgramCode":{
            "title":"Program Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the associated maintenance program.",
            "nullable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the adjustments was created.",
            "format":"date",
            "nullable":false
        },
        "DynamicMatrixClassName":{
            "title":"Entitlement Type",
            "type":"string",
            "description":"The alternate value that uniquely identifies the dynamic matrix class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ProgramOrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The organization identifier of the associated maintenance program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"255"
            }
        },
        "CoverageHeaderPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The value that uniquely identifies the standard coverage.",
            "nullable":true
        },
        "CoverageHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the internal standard coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "MatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : entitlements-item-response

Type: object

Show Source

• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• AssetId: integer (int64)
  The unique identifier of the covered asset.
• ChannelCode: string
  Maximum Length: 120

  The code for the service request channel.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account.
• CustomerPartyId: integer (int64)
  The unique identifier of the customer party.
• entitlementDetails: array Entitlement Details
  Title: Entitlement Details

  The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.
• EntitlementsInputId: integer (int64)
  The unique identifier of the entitlement input.
• EntitlementsInputPuid: string
  Maximum Length: 120

  The public unique identifier of the entitlements input.
• InventoryItemId: integer (int64)
  The unique identifier of the inventory item.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PartyContactId: integer (int64)
  The unique identifier of the party contact.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartySiteId: integer (int64)
  The unique identifier of the party site.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• ServiceRequestId: integer (int64)
  The unique identifier of the service request.
• ServiceRequestReportedDate: string (date)
  The date the service request was reported.
• SeverityCode: string
  Maximum Length: 120

  The code for the service request severity.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementsInputPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the entitlements input.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "InventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChannelCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The code for the service request channel.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerPartyId":{
            "type":"integer",
            "description":"The unique identifier of the customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartyContactId":{
            "type":"integer",
            "description":"The unique identifier of the party contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ServiceRequestId":{
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "entitlementDetails":{
            "title":"Entitlement Details",
            "type":"array",
            "description":"The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-item-response"
            }
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntitlementsInputId":{
            "type":"integer",
            "description":"The unique identifier of the entitlement input.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SeverityCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The code for the service request severity.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ServiceRequestReportedDate":{
            "type":"string",
            "description":"The date the service request was reported.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"The unique identifier of the covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Entitlement Details

Type: array

Title: Entitlement Details

The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.

Show Source

• Array of: object entitlements-entitlementDetails-item-response

{
    "title":"Entitlement Details",
    "type":"array",
    "description":"The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-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 : entitlements-entitlementDetails-item-response

Type: object

Show Source

• AssetGroupId: integer (int64)
  The unique identifier of the asset group.
• ChannelCode: string
  Maximum Length: 120

  The channel code associated with the service request.
• chargeAdjustments: array Charge Adjustments
  Title: Charge Adjustments

  The charge adjustments resource is used to view the subscription entitlement charge adjustments. The charge adjustment object has the details such as service activity name, billing type, adjustment type, adjustment value.
• CoverageDescription: string
  Maximum Length: 1000

  The description of the coverage.
• CoverageId: integer (int64)
  The unique identifier of the coverage.
• CoverageLineNumber: string
  Maximum Length: 120

  The line number of the associated coverage.
• CoverageName: string
  Maximum Length: 150

  The name of the coverage.
• CoverageProductDescription: string
  Maximum Length: 120

  The description of the product coverage.
• CoverageProductId: integer (int64)
  The unique identifier of the coverage product.
• CoverageProductName: string
  Maximum Length: 120

  The name of the product associated with the coverage.
• CoverageProductPuid: string
  Maximum Length: 120

  The public unique identifier of the coverage product.
• CoveragePuid: string
  Maximum Length: 120

  The public unique identifier of the coverage.
• CoveredAssetClosedDate: string (date)
  The subscription product association product close date.
• CoveredAssetEndDate: string (date)
  The end date of the covered asset.
• CoveredAssetId: integer (int64)
  The unique identifier of the covered asset.
• CoveredAssetLinenum: string
  Maximum Length: 300

  The line number of the associated coverage asset.
• CoveredAssetProdDescription: string
  Maximum Length: 320

  The description of the product associated with the covered asset.
• CoveredAssetProdName: string
  Maximum Length: 200

  The name of the product associated with the covered asset.
• CoveredAssetStartDate: string (date)
  The start date of the covered asset.
• CoveredInventoryItemId: integer (int64)
  The unique identifier of the covered inventory item.
• CoveredLevelCode: string
  Maximum Length: 30

  The code representing the covered level.
• CoveredLevelId: integer (int64)
  The unique identifier of the covered level.
• CoveredLevelName: string
  Maximum Length: 660

  The name of the covered level.
• CoveredLevelNumber: string
  Maximum Length: 100

  The number of the covered level.
• CoveredLevelPuid: string
  Maximum Length: 120

  The public unique identifier of the covered level.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• CustomerAccountId: integer (int64)
  The unique identifier of the customer account.
• CustomerPartyName: string
  Maximum Length: 120

  The name of the associated customer party.
• EndDate: string (date)
  The end date of the coverage.
• entitlementResults: array Entitlement Results
  Title: Entitlement Results

  The entitlement results resource is used to view the subscription entitlement results. The entitlement results object has the details such as schedule,matrix result.
• EntitlementsId: integer (int64)
  The unique identifier of the subscriptions entitlement.
• EntitlementsInputId: integer (int64)
  The unique identifier of the entitlements input.
• EntitlementsResultId: integer (int64)
  The unique identifier of the entitlements result.
• EntitlementsRuleId: integer (int64)
  The unique identifier of the entitlements rule.
• EntitlementsSource: string
  Maximum Length: 120

  The source of the entitlement.
• EntitlementsSourceCode: string
  Maximum Length: 120

  The source code of the entitlements.
• IsSubscriptionEntitled: string
  Maximum Length: 1

  Indicates if the subscription is entitled.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixId: integer (int64)
  The unique identifier of the coverage matrix.
• Message: string
  Maximum Length: 320

  The message associated with the entitlement.
• PartyContactId: integer (int64)
  The unique identifier of the party contact.
• PartyId: integer (int64)
  The unique identifier of the party.
• PartySiteId: integer (int64)
  The unique identifier of the party site.
• ProductGroupId: integer (int64)
  The unique identifier of the product group.
• RuleEndDate: string (date)
  The end date of the entitlement rule.
• RuleStartDate: string (date)
  The start date of the entitlement rules.
• SerialNumber: string
  Maximum Length: 80

  The serial number of the entitlement.
• ServiceRequestId: integer (int64)
  The unique identifier of the service request.
• SeverityCode: string
  Maximum Length: 120

  The code associated with the severity of the entitlement.
• StartDate: string (date)
  The start date of the coverage.
• subscriptionCoverageHeader: array Standard Coverages
  Title: Standard Coverages

  The standard coverages resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.
• SubscriptionId: integer (int64)
  The unique identifier of the subscription.
• SubscriptionNumber: string
  Maximum Length: 120

  The alternate unique identifier of the subscription.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleEndDate":{
            "type":"string",
            "description":"The end date of the entitlement rule.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementsSourceCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The source code of the entitlements.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageDescription":{
            "maxLength":"1000",
            "type":"string",
            "description":"The description of the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelNumber":{
            "maxLength":"100",
            "type":"string",
            "description":"The number of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "CoveredAssetId":{
            "type":"integer",
            "description":"The unique identifier of the covered asset.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"The start date of the coverage.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartySiteId":{
            "type":"integer",
            "description":"The unique identifier of the party site.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AssetGroupId":{
            "type":"integer",
            "description":"The unique identifier of the asset group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoveredAssetStartDate":{
            "type":"string",
            "description":"The start date of the covered asset.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoveredLevelName":{
            "maxLength":"660",
            "type":"string",
            "description":"The name of the covered level.",
            "nullable":true,
            "x-queryable":false
        },
        "EntitlementsSource":{
            "maxLength":"120",
            "type":"string",
            "description":"The source of the entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredAssetLinenum":{
            "maxLength":"300",
            "type":"string",
            "description":"The line number of the associated coverage asset.",
            "nullable":true,
            "x-queryable":true
        },
        "SerialNumber":{
            "maxLength":"80",
            "type":"string",
            "description":"The serial number of the entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "SeverityCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The code associated with the severity of the entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"The unique identifier of the coverage matrix.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerPartyName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the associated customer party.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementsId":{
            "type":"integer",
            "description":"The unique identifier of the subscriptions entitlement.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "Message":{
            "maxLength":"320",
            "type":"string",
            "description":"The message associated with the entitlement.",
            "nullable":true,
            "x-queryable":true
        },
        "IsSubscriptionEntitled":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the subscription is entitled.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageName":{
            "maxLength":"150",
            "type":"string",
            "description":"The name of the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "ChannelCode":{
            "maxLength":"120",
            "type":"string",
            "description":"The channel code associated with the service request.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageProductName":{
            "maxLength":"120",
            "type":"string",
            "description":"The name of the product associated with the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code representing the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredAssetClosedDate":{
            "type":"string",
            "description":"The subscription product association product close date.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredInventoryItemId":{
            "type":"integer",
            "description":"The unique identifier of the covered inventory item.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriptionId":{
            "type":"integer",
            "description":"The unique identifier of the subscription.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EntitlementsRuleId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveredLevelPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the covered level.",
            "nullable":true,
            "x-queryable":true
        },
        "subscriptionCoverageHeader":{
            "title":"Standard Coverages",
            "type":"array",
            "description":"The standard coverages resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-subscriptionCoverageHeader-item-response"
            }
        },
        "CoverageId":{
            "type":"integer",
            "description":"The unique identifier of the coverage.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CustomerAccountId":{
            "type":"integer",
            "description":"The unique identifier of the customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveredAssetProdName":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the product associated with the covered asset.",
            "nullable":true,
            "x-queryable":true
        },
        "ProductGroupId":{
            "type":"integer",
            "description":"The unique identifier of the product group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The alternate unique identifier of the subscription.",
            "nullable":true,
            "x-queryable":true
        },
        "chargeAdjustments":{
            "title":"Charge Adjustments",
            "type":"array",
            "description":"The charge adjustments resource is used to view the subscription entitlement charge adjustments. The charge adjustment object has the details such as service activity name, billing type, adjustment type, adjustment value.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-chargeAdjustments-item-response"
            }
        },
        "entitlementResults":{
            "title":"Entitlement Results",
            "type":"array",
            "description":"The entitlement results resource is used to view the subscription entitlement results. The entitlement results object has the details such as schedule,matrix result.",
            "items":{
                "$ref":"#/components/schemas/entitlements-entitlementDetails-entitlementResults-item-response"
            }
        },
        "RuleStartDate":{
            "type":"string",
            "description":"The start date of the entitlement rules.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredLevelId":{
            "type":"integer",
            "description":"The unique identifier of the covered level.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"The end date of the coverage.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "PartyContactId":{
            "type":"integer",
            "description":"The unique identifier of the party contact.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ServiceRequestId":{
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveredAssetProdDescription":{
            "maxLength":"320",
            "type":"string",
            "description":"The description of the product associated with the covered asset.",
            "nullable":true,
            "x-queryable":true
        },
        "PartyId":{
            "type":"integer",
            "description":"The unique identifier of the party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoveragePuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementsInputId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements input.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoverageLineNumber":{
            "maxLength":"120",
            "type":"string",
            "description":"The line number of the associated coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoveredAssetEndDate":{
            "type":"string",
            "description":"The end date of the covered asset.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageProductPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The public unique identifier of the coverage product.",
            "nullable":true,
            "x-queryable":true
        },
        "EntitlementsResultId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements result.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CoverageProductId":{
            "type":"integer",
            "description":"The unique identifier of the coverage product.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageProductDescription":{
            "maxLength":"120",
            "type":"string",
            "description":"The description of the product coverage.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Charge Adjustments

Type: array

Title: Charge Adjustments

The charge adjustments resource is used to view the subscription entitlement charge adjustments. The charge adjustment object has the details such as service activity name, billing type, adjustment type, adjustment value.

Show Source

• Array of: object entitlements-entitlementDetails-chargeAdjustments-item-response

{
    "title":"Charge Adjustments",
    "type":"array",
    "description":"The charge adjustments resource is used to view the subscription entitlement charge adjustments. The charge adjustment object has the details such as service activity name, billing type, adjustment type, adjustment value.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-chargeAdjustments-item-response"
    }
}

Nested Schema : Entitlement Results

Type: array

Title: Entitlement Results

The entitlement results resource is used to view the subscription entitlement results. The entitlement results object has the details such as schedule,matrix result.

Show Source

• Array of: object entitlements-entitlementDetails-entitlementResults-item-response

{
    "title":"Entitlement Results",
    "type":"array",
    "description":"The entitlement results resource is used to view the subscription entitlement results. The entitlement results object has the details such as schedule,matrix result.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-entitlementResults-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 : Standard Coverages

Type: array

Title: Standard Coverages

The standard coverages resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.

Show Source

• Array of: object entitlements-entitlementDetails-subscriptionCoverageHeader-item-response

{
    "title":"Standard Coverages",
    "type":"array",
    "description":"The standard coverages resource is used to view, create, update, and delete a standard coverage. It provides details of standard coverage information.",
    "items":{
        "$ref":"#/components/schemas/entitlements-entitlementDetails-subscriptionCoverageHeader-item-response"
    }
}

Nested Schema : entitlements-entitlementDetails-chargeAdjustments-item-response

Type: object

Show Source

• AdjustmentAmount: number
  Title: Value

  The value of the adjustment.
• AdjustmentTypeCode: string
  Maximum Length: 30

  The code associated with the adjustment type.
• AdjustmentTypeMeaning: string
  Title: Adjustment Type

  The description of the adjustment type.
• AllowCustomAdjustmentsFlag: boolean
  Title: Allow custom adjustments

  Maximum Length: 1

  Indicates whether custom adjustments are allowed. The Default value is True.
• AllowPricingDiscountsFlag: boolean
  Title: Allow pricing discounts

  Maximum Length: 1

  Indicates whether pricing discounts are allowed. The default value is False.
• BillingTypeCode: string
  Maximum Length: 30

  The code associated with the billing type.
• BillingTypeMeaning: string
  Title: Billing Type

  The description of the billing type.
• BusinessProcessCode: string
  Maximum Length: 30

  The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• BusinessProcessMeaning: string
  Title: Business Process

  The display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.
• ChargeDiscountId: integer (int64)
  The unique identifier of the charge discount.
• CoverageDiscountPuid: string
  Maximum Length: 120

  The value that uniquely identifies the adjustments.
• CoverageHeaderId: integer (int64)
  The unique identifier of the coverage header.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• EndDate: string (date)
  Title: End Date

  The end date of the adjustment.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PricingBasisId: integer
  The unique identifier of the pricing basis.
• PricingBasisName: string
  Title: Adjustment Basis

  The name of the pricing basis.
• PricingTermId: integer
  The unique identifier of the pricing term.
• ServiceActivityId: integer (int64)
  The unique identifier of the service request.
• ServiceActivityName: string
  Title: Service Activity

  Maximum Length: 80

  The name of the service request.
• StartDate: string (date)
  Title: Start Date

  The start date of the adjustment.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillingTypeMeaning":{
            "title":"Billing Type",
            "type":"string",
            "description":"The description of the billing type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "AdjustmentTypeMeaning":{
            "title":"Adjustment Type",
            "type":"string",
            "description":"The description of the adjustment type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PricingBasisName":{
            "title":"Adjustment Basis",
            "type":"string",
            "description":"The name of the pricing basis.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ChargeDiscountId":{
            "type":"integer",
            "description":"The unique identifier of the charge discount.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PricingBasisId":{
            "type":"integer",
            "description":"The unique identifier of the pricing basis.",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the adjustment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceActivityId":{
            "type":"integer",
            "description":"The unique identifier of the service request.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "AdjustmentAmount":{
            "title":"Value",
            "type":"number",
            "description":"The value of the adjustment.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoverageHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the coverage header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BusinessProcessCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The unique code for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process code. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CoverageDiscountPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The value that uniquely identifies the adjustments.",
            "nullable":true,
            "x-queryable":true
        },
        "BillingTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with the billing type.",
            "nullable":true,
            "x-queryable":true
        },
        "BusinessProcessMeaning":{
            "title":"Business Process",
            "type":"string",
            "description":"The display value for the business process type lookup. A list of accepted values is defined in the lookup type ORA_RCL_BUSINESS_PROCESS for business process meaning. Review and update the list of values using the Setup and Maintenance work area, and the Manage Service Logistics Lookups task.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the adjustment.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ServiceActivityName":{
            "title":"Service Activity",
            "maxLength":"80",
            "type":"string",
            "description":"The name of the service request.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "AdjustmentTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"The code associated with the adjustment type.",
            "nullable":false,
            "x-queryable":true
        },
        "AllowPricingDiscountsFlag":{
            "title":"Allow pricing discounts",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether pricing discounts are allowed. The default value is False.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowCustomAdjustmentsFlag":{
            "title":"Allow custom adjustments",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether custom adjustments are allowed. The Default value is True.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PricingTermId":{
            "type":"integer",
            "description":"The unique identifier of the pricing term.",
            "nullable":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."
        }
    }
}

Nested Schema : entitlements-entitlementDetails-entitlementResults-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

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

  The date when the record was created.
• EntitlementsId: integer (int64)
  The unique identifier of the entailments.
• EntitlementsResultId: integer (int64)
  The unique identifier of the entitlements result.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the record was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  The object version number for the entitlement.
• ResultName: string
  Maximum Length: 240

  The name of the result.
• ResultThresholdValue: string
  Maximum Length: 240

  The threshold value for the entitlement result.
• ResultValue: string
  Maximum Length: 240

  The value of the result.
• ScheduleId: integer (int64)
  The unique identifier of the schedule associated with the entitlement.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResultThresholdValue":{
            "maxLength":"240",
            "type":"string",
            "description":"The threshold value for the entitlement result.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntitlementsId":{
            "type":"integer",
            "description":"The unique identifier of the entailments.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResultValue":{
            "maxLength":"240",
            "type":"string",
            "description":"The value of the result.",
            "nullable":true,
            "x-queryable":true
        },
        "ScheduleId":{
            "type":"integer",
            "description":"The unique identifier of the schedule associated with the entitlement.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ResultName":{
            "maxLength":"240",
            "type":"string",
            "description":"The name of the result.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number for the entitlement.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "EntitlementsResultId":{
            "type":"integer",
            "description":"The unique identifier of the entitlements result.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "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 : entitlements-entitlementDetails-subscriptionCoverageHeader-item-response

Type: object

Show Source

• CoverageDescription: string
  Title: Template Description

  Maximum Length: 1000

  The value that uniquely identifies the standard coverage description.
• CoverageHeaderId: integer (int64)
  The unique identifier of the internal standard coverage.
• CoverageHeaderPuid: string
  Maximum Length: 120

  The value that uniquely identifies the standard coverage.
• CoverageName: string
  Title: Template Name

  Maximum Length: 150

  The name of the standard coverage.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who created the standard coverage record.
• CreationDate: string (date-time)
  Read Only: true

  The date when the standard coverage was created.
• DynamicMatrixClassId: integer (int64)
  Title: Entitlement Type

  The unique identifier of the dynamic matrix class.
• DynamicMatrixClassName: string
  Title: Entitlement Type

  The alternate value that uniquely identifies the dynamic matrix class.
• EndDate: string (date)
  Title: End Date

  The date when the standard coverage ends.
• LastUpdateDate: string (date-time)
  Read Only: true

  The date when the standard coverage was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  The user who last updated the standard coverage.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  The name of the user who has last updated the standard coverage.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MatrixId: integer (int64)
  The unique identifier of the dynamic matrix.
• MatrixName: string
  The name of the matrix.
• ProgramCode: string
  Title: Program Code

  Maximum Length: 30

  The code of the associated maintenance program.
• ProgramDescription: string
  Title: Description

  Read Only: true

  Maximum Length: 240

  The description of the associated maintenance program.
• ProgramEndDate: string (date)
  Title: End Date

  Read Only: true

  The end date of the associated maintenance program.
• ProgramId: integer (int64)
  The identifier of the associated maintenance program.
• ProgramName: string
  Title: Program Name

  Maximum Length: 120

  The name of the associated maintenance program.
• ProgramOrganizationId: integer (int64)
  Title: Organization

  The organization identifier of the associated maintenance program.
• ProgramStartDate: string (date)
  Title: Start Date

  Read Only: true

  The start date of the associated maintenance program.
• StandardCoverageYn: string
  Maximum Length: 1

  Indicates whether coverage is standard coverage. The default value is False.
• StartDate: string (date)
  Title: Start Date

  The date when the adjustments was created.
• SubscriptionProductPuid: string
  The value that uniquely identifies the subscription product.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"The date when the standard coverage was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "StandardCoverageYn":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether coverage is standard coverage. The default value is False.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageName":{
            "title":"Template Name",
            "maxLength":"150",
            "type":"string",
            "description":"The name of the standard coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageDescription":{
            "title":"Template Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The value that uniquely identifies the standard coverage description.",
            "nullable":false,
            "x-queryable":true
        },
        "MatrixName":{
            "type":"string",
            "description":"The name of the matrix.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "StartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The date when the adjustments was created.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "ProgramDescription":{
            "title":"Description",
            "maxLength":"240",
            "type":"string",
            "description":"The description of the associated maintenance program.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramStartDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the associated maintenance program.",
            "format":"date",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "CoverageHeaderPuid":{
            "maxLength":"120",
            "type":"string",
            "description":"The value that uniquely identifies the standard coverage.",
            "nullable":true,
            "x-queryable":true
        },
        "CoverageHeaderId":{
            "type":"integer",
            "description":"The unique identifier of the internal standard coverage.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the standard coverage.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the standard coverage record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DynamicMatrixClassId":{
            "title":"Entitlement Type",
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix class.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "SubscriptionProductPuid":{
            "type":"string",
            "description":"The value that uniquely identifies the subscription product.",
            "nullable":true,
            "x-queryable":false
        },
        "ProgramId":{
            "type":"integer",
            "description":"The identifier of the associated maintenance program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "EndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The date when the standard coverage ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "title":"Program Name",
            "maxLength":"120",
            "type":"string",
            "description":"The name of the associated maintenance program.",
            "nullable":true,
            "x-hints":{
                "controlType":"input_text_lov"
            },
            "x-queryable":true
        },
        "ProgramCode":{
            "title":"Program Code",
            "maxLength":"30",
            "type":"string",
            "description":"The code of the associated maintenance program.",
            "nullable":true,
            "x-queryable":true
        },
        "DynamicMatrixClassName":{
            "title":"Entitlement Type",
            "type":"string",
            "description":"The alternate value that uniquely identifies the dynamic matrix class.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ProgramOrganizationId":{
            "title":"Organization",
            "type":"integer",
            "description":"The organization identifier of the associated maintenance program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"255"
            },
            "x-queryable":true
        },
        "ProgramEndDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the associated maintenance program.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MatrixId":{
            "type":"integer",
            "description":"The unique identifier of the dynamic matrix.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the standard coverage was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":"32",
            "type":"string",
            "description":"The name of the user who has last updated the standard coverage.",
            "nullable":true,
            "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"
    }
}

Links

entitlementDetails

Operation: /crmRestApi/resources/11.13.18.05/entitlements/{EntitlementsInputPuid}/child/entitlementDetails

Parameters:

• EntitlementsInputPuid: $request.path.EntitlementsInputPuid

The entitlement details resource is used to view the subscription entitlement details. The entitlement details object has the details such as entitlement source, coverage name, entitlment matrix results.

Back to Top