Update an entitlement assignment
patch
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}
Request
Path Parameters
-
EntitlementAssignmentNumber(required): string
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
Root Schema : schema
Type:
Show Source
object
-
assignmentCriteria: array
Subscription Balance Consumption Criteria
Title:
Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later. -
AssignmentPrecedence: integer
Title:
Precedence
The precedence of assignment of subscription entitlement assignment. -
AssignmentStatus: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of assignment of subscription entitlement assignment. -
EndDateActive: string
(date)
Title:
End Date
The end date till which assignment is active in subscription entitlement assignment. -
EntitlementPlanId: integer
(int64)
The unique entitlement plan identifier of subscription entitlement assignment.
-
EntitlementPlanName: string
Title:
Entitlement Plan Name
Maximum Length:120
The entitlement plan name of subscription entitlement assignment. -
EntitlementPlanNumber: string
Title:
Entitlement Plan Number
Maximum Length:120
The entitlement plan number of subscription entitlement assignment. -
InventoryItemId: integer
(int64)
The inventory item identifier of subscription entitlement assignment.
-
InventoryItemName: string
Title:
Product Name
Maximum Length:300
The inventory item name of subscription entitlement assignment. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement assignment.
-
OrganizationCode: string
Title:
Organization
Maximum Length:18
The organization code of subscription entitlement assignment. -
OrganizationId: integer
(int64)
The organization identifier of subscription entitlement assignment.
-
StartDateActive: string
(date)
Title:
Start Date
The start date from which assignment is active in subscription entitlement assignment.
Nested Schema : Subscription Balance Consumption Criteria
Type:
array
Title:
Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
BalanceCriteriaDescription: string
Title:
Description
Maximum Length:300
The description of subscription balance consumption criterion. -
BalanceCriteriaNumber: string
Title:
Criteria
Maximum Length:120
The unique number of the subscription balance consumption criterion. -
BalanceCriteriaStatus: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of the subscription balance consumption criterion. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance consumption criterion.
-
subscriptionBalancePredicates: array
Subscription Balance Consumption Predicates
Title:
Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Nested Schema : Subscription Balance Consumption Predicates
Type:
array
Title:
Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
BalanceAttributeId: integer
(int64)
The unique identifier of the subscription balance consumption attribute.
-
BalanceAttributeName: string
Title:
Attribute Name
Maximum Length:240
The name of the subscription balance consumption attribute. -
BalanceCriteriaId: integer
(int64)
The balance criteria identifier of subscription balance consumption predicate.
-
BalanceObjectId: integer
(int64)
The balance object identifier of subscription balance consumption predicate.
-
BalanceObjectName: string
Title:
Object Name
Maximum Length:120
The balance object name of subscription balance consumption predicate. -
BalancePredicateCharacterValue: string
Title:
Value
Maximum Length:600
The balance predicate character value of subscription balance consumption predicate. -
BalancePredicateDateValue: string
(date)
Title:
Value
The balance predicate date value of subscription balance consumption predicate. -
BalancePredicateDecimalValue: number
Title:
Value
The balance predicate decimal value of subscription balance consumption predicate. -
BalancePredicateNumberValue: integer
Title:
Value
The number value of the subscription balance consumption predicate. -
BalancePredicateOperator: string
Title:
Operator
Maximum Length:30
The operator value of the subscription balance consumption predicate. -
BalancePredicateSequence: integer
Title:
Sequence
The balance predicate sequence of the subscription balance consumption predicate. -
BalancePredicateSortBy: string
Title:
Sort Order
Maximum Length:30
The sort by criterion of the subscription balance consumption predicate. -
BalancePredicateTimeValue: string
(date-time)
Title:
Value
The time value of the subscription balance consumption predicate.
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.
Root Schema : subscriptionEntitlementAssignments-item-response
Type:
Show Source
object
-
assignmentCriteria: array
Subscription Balance Consumption Criteria
Title:
Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later. -
AssignmentPrecedence: integer
Title:
Precedence
The precedence of assignment of subscription entitlement assignment. -
AssignmentStatus: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of assignment of subscription entitlement assignment. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement assignment. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement assignment was created. -
EndDateActive: string
(date)
Title:
End Date
The end date till which assignment is active in subscription entitlement assignment. -
EntitlementAssignmentId: integer
(int64)
The unique identifier of subscription entitlement assignment.
-
EntitlementAssignmentNumber: string
Title:
Number
Maximum Length:120
The number of subscription entitlement assignment. -
EntitlementPlanId: integer
(int64)
The unique entitlement plan identifier of subscription entitlement assignment.
-
EntitlementPlanName: string
Title:
Entitlement Plan Name
Maximum Length:120
The entitlement plan name of subscription entitlement assignment. -
EntitlementPlanNumber: string
Title:
Entitlement Plan Number
Maximum Length:120
The entitlement plan number of subscription entitlement assignment. -
InventoryItemId: integer
(int64)
The inventory item identifier of subscription entitlement assignment.
-
InventoryItemName: string
Title:
Product Name
Maximum Length:300
The inventory item name of subscription entitlement assignment. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement assignment was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription entitlement assignment. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement assignment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The version number of subscription entitlement assignment.
-
OrganizationCode: string
Title:
Organization
Maximum Length:18
The organization code of subscription entitlement assignment. -
OrganizationId: integer
(int64)
The organization identifier of subscription entitlement assignment.
-
StartDateActive: string
(date)
Title:
Start Date
The start date from which assignment is active in subscription entitlement assignment.
Nested Schema : Subscription Balance Consumption Criteria
Type:
array
Title:
Subscription Balance Consumption Criteria
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-item-response
Type:
Show Source
object
-
BalanceCriteriaDescription: string
Title:
Description
Maximum Length:300
The description of subscription balance consumption criterion. -
BalanceCriteriaId: integer
(int64)
The unique identifier of the subscription balance consumption criterion.
-
BalanceCriteriaNumber: string
Title:
Criteria
Maximum Length:120
The unique number of the subscription balance consumption criterion. -
BalanceCriteriaStatus: string
Title:
Status
Maximum Length:30
Default Value:ORA_OSS_DRAFT
The status of the subscription balance consumption criterion. -
BalanceCriteriaUsage: string
Title:
Usage
Maximum Length:30
The usage condition of subscription balance consumption criterion. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance consumption criterion. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption criterion was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption criterion was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance consumption criterion. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance consumption criterion. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance consumption criterion.
-
subscriptionBalancePredicates: array
Subscription Balance Consumption Predicates
Title:
Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Consumption Predicates
Type:
array
Title:
Subscription Balance Consumption Predicates
The subscription balance consumption predicates resource is used to view, create, update, and delete balance predicate.You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-response
Type:
Show Source
object
-
BalanceAttributeId: integer
(int64)
The unique identifier of the subscription balance consumption attribute.
-
BalanceAttributeName: string
Title:
Attribute Name
Maximum Length:240
The name of the subscription balance consumption attribute. -
BalanceCriteriaId: integer
(int64)
The balance criteria identifier of subscription balance consumption predicate.
-
BalanceObjectId: integer
(int64)
The balance object identifier of subscription balance consumption predicate.
-
BalanceObjectName: string
Title:
Object Name
Maximum Length:120
The balance object name of subscription balance consumption predicate. -
BalancePredicateCharacterValue: string
Title:
Value
Maximum Length:600
The balance predicate character value of subscription balance consumption predicate. -
BalancePredicateDateValue: string
(date)
Title:
Value
The balance predicate date value of subscription balance consumption predicate. -
BalancePredicateDecimalValue: number
Title:
Value
The balance predicate decimal value of subscription balance consumption predicate. -
BalancePredicateId: integer
(int64)
The unique identifier of the subscription balance consumption predicate.
-
BalancePredicateNumber: string
Title:
Number
Maximum Length:120
The unique number of the subscription balance consumption predicate. -
BalancePredicateNumberValue: integer
Title:
Value
The number value of the subscription balance consumption predicate. -
BalancePredicateOperator: string
Title:
Operator
Maximum Length:30
The operator value of the subscription balance consumption predicate. -
BalancePredicateSequence: integer
Title:
Sequence
The balance predicate sequence of the subscription balance consumption predicate. -
BalancePredicateSortBy: string
Title:
Sort Order
Maximum Length:30
The sort by criterion of the subscription balance consumption predicate. -
BalancePredicateTimeValue: string
(date-time)
Title:
Value
The time value of the subscription balance consumption predicate. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription balance consumption predicate. -
CreationDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption predicate was created. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription balance consumption predicate was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who has last updated the subscription balance consumption predicate. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription balance consumption predicate. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The object version number of the subscription balance consumption predicate.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- activate
-
Parameters:
- EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
The method is used to activate entitlement assignment. - EntitlementAssignmentNumber:
- assignmentCriteria
-
Parameters:
- EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
The subscription balance consumption criteria resource is used to view, create, update, and delete balance criteria. You can define the rules on how the allowance has to be consumed in the order or preference. For example if the rollover balance has to be consumed first or later. - EntitlementAssignmentNumber:
- deActivate
-
Parameters:
- EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
The method is used to deactivate entitlement assignment. - EntitlementAssignmentNumber:
Examples
The following example shows how to update a subscription entitlement assignment by submitting a PATCH request on the REST resource.
cURL Command
curl -u <username:password> \ -X PATCH https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/latest/subscriptionEntitlementAssignments/CDRM_7004 \ -H 'Content-Type: application/vnd.oracle.adf.resourceitem+json' | json_pp
Example of Request Body
The following shows the contents of the request body in JSON format.
{ "AssignmentPrecedence": 1021 }
Example of Response Body
The following example shows the contents of the response body in JSON format.
{ "EntitlementAssignmentId": 300100570207771, "EntitlementAssignmentNumber": "CDRM_7004", "OrganizationCode": "V1", "OrganizationId": 204, "InventoryItemName": "QP_Item3", "InventoryItemId": 300100012368232, "EntitlementPlanNumber": "CDRM_1", "EntitlementPlanId": 300100570153904, "EntitlementPlanName": "Platinum Plan", "AssignmentPrecedence": 1021, "StartDateActive": "2023-03-01", "EndDateActive": null, "AssignmentStatus": "ORA_OSS_DRAFT", "ObjectVersionNumber": 2, "CreatedBy": "CONMGR", "CreationDate": "2023-03-01T15:05:58+00:00", "LastUpdatedBy": "CONMGR", "LastUpdateDate": "2023-03-01T15:15:05+00:00", "LastUpdateLogin": "F5D244E63FDB3FFBE053B4A7456445B7", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004", "name": "subscriptionEntitlementAssignments", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000278" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004", "name": "subscriptionEntitlementAssignments", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/child/assignmentCriteria", "name": "assignmentCriteria", "kind": "collection" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/action/activate", "name": "activate", "kind": "other" }, { "rel": "action", "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/CDRM_7004/action/deActivate", "name": "deActivate", "kind": "other" } ] }