Jump to

• Request
• Response

Get all subscription entitlement details

get

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

Request

Path Parameters

• EntitlementsInputPuid(required): string
  The public unique identifier of the entitlements input.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

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

  • AssetGroupId; integer; The unique identifier of the asset group.
  • ChannelCode; string; The channel code associated with the service request.
  • CoverageDescription; string; The description of the coverage.
  • CoverageId; integer; The unique identifier of the coverage.
  • CoverageLineNumber; string; The line number of the associated coverage.
  • CoverageName; string; The name of the coverage.
  • CoverageProductDescription; string; The description of the product coverage.
  • CoverageProductId; integer; The unique identifier of the coverage product.
  • CoverageProductName; string; The name of the product associated with the coverage.
  • CoverageProductPuid; string; The public unique identifier of the coverage product.
  • CoveragePuid; string; The public unique identifier of the coverage.
  • CoveredAssetClosedDate; string; The subscription product association product close date.
  • CoveredAssetEndDate; string; The end date of the covered asset.
  • CoveredAssetId; integer; The unique identifier of the covered asset.
  • CoveredAssetLinenum; string; The line number of the associated coverage asset.
  • CoveredAssetProdDescription; string; The description of the product associated with the covered asset.
  • CoveredAssetProdName; string; The name of the product associated with the covered asset.
  • CoveredAssetStartDate; string; The start date of the covered asset.
  • CoveredInventoryItemId; integer; The unique identifier of the covered inventory item.
  • CoveredLevelCode; string; The code representing the covered level.
  • CoveredLevelId; integer; The unique identifier of the covered level.
  • CoveredLevelPuid; string; The public unique identifier of the covered level.
  • CreatedBy; string; The user who created the record.
  • CreationDate; string; The date when the record was created.
  • CustomerAccountId; integer; The unique identifier of the customer account.
  • CustomerPartyName; string; The name of the associated customer party.
  • EndDate; string; The end date of the coverage.
  • EntitlementsId; integer; The unique identifier of the subscriptions entitlement.
  • EntitlementsInputId; integer; The unique identifier of the entitlements input.
  • EntitlementsResultId; integer; The unique identifier of the entitlements result.
  • EntitlementsRuleId; integer; The unique identifier of the entitlements rule.
  • EntitlementsSource; string; The source of the entitlement.
  • EntitlementsSourceCode; string; The source code of the entitlements.
  • IsSubscriptionEntitled; string; Indicates if the subscription is entitled.
  • LastUpdateDate; string; The date when the record was last updated.
  • LastUpdateLogin; string; The login of the user who last updated the record.
  • LastUpdatedBy; string; The user who last updated the record.
  • MatrixId; integer; The unique identifier of the coverage matrix.
  • Message; string; The message associated with the entitlement.
  • PartyContactId; integer; The unique identifier of the party contact.
  • PartyId; integer; The unique identifier of the party.
  • PartySiteId; integer; The unique identifier of the party site.
  • ProductGroupId; integer; The unique identifier of the product group.
  • RuleEndDate; string; The end date of the entitlement rule.
  • RuleStartDate; string; The start date of the entitlement rules.
  • SerialNumber; string; The serial number of the entitlement.
  • ServiceRequestId; integer; The unique identifier of the service request.
  • SeverityCode; string; The code associated with the severity of the entitlement.
  • StartDate; string; The start date of the coverage.
  • SubscriptionId; integer; The unique identifier of the subscription.
  • SubscriptionNumber; string; The alternate unique identifier of the subscription.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Header Parameters

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

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : entitlements-entitlementDetails

Type: object

Show Source

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

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

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

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

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

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

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "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"
    }
}

Back to Top