Update a balance condition criterion
patch
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementAssignments/{EntitlementAssignmentNumber}/child/assignmentCriteria/{BalanceCriteriaNumber}
Request
Path Parameters
-
BalanceCriteriaNumber(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=
-
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: string
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: string
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-
BalanceCriteriaDescription: string
Title:
DescriptionMaximum Length:300The description of subscription balance criterion. -
BalanceCriteriaNumber: string
Title:
CriteriaMaximum Length:120The unique number of the subscription balance criterion. -
BalanceCriteriaStatus: string
Title:
StatusMaximum Length:30Default Value:ORA_OSS_DRAFTThe status of the subscription balance criterion. -
CriteriaPrecedence: integer
Title:
SequenceThe order in which the criteria will be evaluated. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance criterion.
-
subscriptionBalancePredicates: array
Subscription Balance Condition Predicates
Title:
Subscription Balance Condition PredicatesThe subscription balance predicates resource is used to view, create, update, and delete a balance predicate.
Nested Schema : Subscription Balance Condition Predicates
Type:
arrayTitle:
Subscription Balance Condition PredicatesThe subscription balance predicates resource is used to view, create, update, and delete a balance predicate.
Show Source
Nested Schema : subscriptionEntitlementAssignments-assignmentCriteria-subscriptionBalancePredicates-item-patch-request
Type:
Show Source
object-
BalanceAttributeId: integer
(int64)
The unique identifier of the subscription balance attribute.
-
BalanceAttributeName: string
Title:
Attribute NameMaximum Length:240The name of the subscription balance attribute. -
BalanceCriteriaId: integer
(int64)
The balance criteria Id of subscription balance predicate.
-
BalanceObjectId: integer
(int64)
The balance object identifier of subscription balance predicate.
-
BalanceObjectName: string
Title:
Object NameMaximum Length:120The balance object name of subscription balance predicate. -
BalancePredicateCharacterValue: string
Title:
ValueMaximum Length:600The balance predicate character value of subscription balance predicate. -
BalancePredicateDateValue: string
(date)
Title:
ValueThe balance predicate date value of subscription balance predicate. -
BalancePredicateDecimalValue: number
Title:
ValueThe balance predicate decimal value of subscription balance predicate. -
BalancePredicateNumberValue: integer
Title:
ValueThe number value of the subscription balance predicate. -
BalancePredicateOperator: string
Title:
OperatorMaximum Length:30The operator value of the subscription balance predicate. -
BalancePredicateSequence: integer
Title:
SequenceThe balance predicate sequence of the subscription balance predicate. -
BalancePredicateSortBy: string
Title:
Sort OrderMaximum Length:30The sort by criterion of the subscription balance predicate. -
BalancePredicateTimeValue: string
(date-time)
Title:
ValueThe time value of the subscription balance predicate. -
SourceType: string
Title:
Source TypeMaximum Length:30Default Value:ORA_OSS_USERThe source type of the subscription balance 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-assignmentCriteria-item-response
Type:
Show Source
object-
BalanceCriteriaDescription: string
Title:
DescriptionMaximum Length:300The description of subscription balance criterion. -
BalanceCriteriaId: integer
(int64)
The unique identifier of the subscription balance criterion.
-
BalanceCriteriaNumber: string
Title:
CriteriaMaximum Length:120The unique number of the subscription balance criterion. -
BalanceCriteriaStatus: string
Title:
StatusMaximum Length:30Default Value:ORA_OSS_DRAFTThe status of the subscription balance criterion. -
BalanceCriteriaUsage: string
Title:
UsageMaximum Length:30The usage condition of subscription balance criterion. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription balance criterion. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the subscription balance criterion was created. -
CriteriaPrecedence: integer
Title:
SequenceThe order in which the criteria will be evaluated. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription balance criterion was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription balance criterion. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription balance criterion. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
The object version number updated after every update of a subscription balance criterion.
-
subscriptionBalancePredicates: array
Subscription Balance Condition Predicates
Title:
Subscription Balance Condition PredicatesThe subscription balance predicates resource is used to view, create, update, and delete a balance predicate.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Subscription Balance Condition Predicates
Type:
arrayTitle:
Subscription Balance Condition PredicatesThe subscription balance predicates resource is used to view, create, update, and delete a balance predicate.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 attribute.
-
BalanceAttributeName: string
Title:
Attribute NameMaximum Length:240The name of the subscription balance attribute. -
BalanceCriteriaId: integer
(int64)
The balance criteria Id of subscription balance predicate.
-
BalanceObjectId: integer
(int64)
The balance object identifier of subscription balance predicate.
-
BalanceObjectName: string
Title:
Object NameMaximum Length:120The balance object name of subscription balance predicate. -
BalancePredicateCharacterValue: string
Title:
ValueMaximum Length:600The balance predicate character value of subscription balance predicate. -
BalancePredicateDateValue: string
(date)
Title:
ValueThe balance predicate date value of subscription balance predicate. -
BalancePredicateDecimalValue: number
Title:
ValueThe balance predicate decimal value of subscription balance predicate. -
BalancePredicateId: integer
(int64)
The unique identifier of the subscription balance predicate.
-
BalancePredicateNumber: string
Title:
NumberMaximum Length:120The unique number of the subscription balance predicate. -
BalancePredicateNumberValue: integer
Title:
ValueThe number value of the subscription balance predicate. -
BalancePredicateOperator: string
Title:
OperatorMaximum Length:30The operator value of the subscription balance predicate. -
BalancePredicateSequence: integer
Title:
SequenceThe balance predicate sequence of the subscription balance predicate. -
BalancePredicateSortBy: string
Title:
Sort OrderMaximum Length:30The sort by criterion of the subscription balance predicate. -
BalancePredicateTimeValue: string
(date-time)
Title:
ValueThe time value of the subscription balance predicate. -
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the subscription balance predicate. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the subscription balance predicate was created. -
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the subscription balance predicate was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who has last updated the subscription balance predicate. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The login of the user who last updated the subscription balance predicate. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
trueThe object version number of the subscription balance predicate. -
SourceType: string
Title:
Source TypeMaximum Length:30Default Value:ORA_OSS_USERThe source type of the subscription balance predicate.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- BalanceCriteriaStatusVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALANCE_MGMT_SETUP_STS
The following properties are defined on the LOV link relation:- Source Attribute: BalanceCriteriaStatus; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- BalanceCriteriaUsageVA
-
Parameters:
- finder:
LookupTypeIsActiveEnabledFinder%3BBindLookupType%3DORA_OSS_BALNCE_CRITERIA_USAGE
The following properties are defined on the LOV link relation:- Source Attribute: BalanceCriteriaUsage; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder:
- subscriptionBalancePredicates
-
Parameters:
- BalanceCriteriaNumber:
$request.path.BalanceCriteriaNumber - EntitlementAssignmentNumber:
$request.path.EntitlementAssignmentNumber
The subscription balance predicates resource is used to view, create, update, and delete a balance predicate. - BalanceCriteriaNumber: