Update an entitlement plan commitment
patch
/crmRestApi/resources/11.13.18.05/subscriptionEntitlementPlans/{EntitlementPlanNumber}/child/commitments/{EntitlementPlanCommitmentNumber}
Request
Path Parameters
-
EntitlementPlanCommitmentNumber(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=
-
EntitlementPlanNumber(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
-
Amount: number
Title:
Amount
The amount of the subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of the subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code of the subscription entitlement plan commitments.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription entitlement plan commitments. -
ChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the subscription entitlement plan commitments.
-
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the subscription entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of entitlement plan of the subscription entitlement plan commitments.
-
Period: string
Title:
Periodicity
The period of the subscription entitlement plan commitments. -
Quantity: number
Title:
Quantity
The quantity of the subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity of the subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The unique identifier of subscription product of the subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of the subscription entitlement plan commitments.
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 : subscriptionEntitlementPlans-commitments-item-response
Type:
Show Source
object
-
Amount: number
Title:
Amount
The amount of the subscription entitlement plan commitments. -
BalanceCode: string
Title:
Balance Code
Maximum Length:30
The balance code of the subscription entitlement plan commitments. -
BalanceCodeId: integer
(int64)
The unique identifier of balance code of the subscription entitlement plan commitments.
-
ChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the subscription entitlement plan commitments. -
ChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the subscription entitlement plan commitments.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the subscription entitlement plan commitments. -
CreationDate: string
(date-time)
Read Only:
true
The date of creation of the subscription entitlement plan commitments. -
CurrencyCode: string
Title:
Currency Code
Maximum Length:15
The currency code of the subscription entitlement plan commitments. -
EntitlementPlanCommitmentId: integer
(int64)
The unique identifier of entitlement plan commitments.
-
EntitlementPlanCommitmentNumber: string
Maximum Length:
120
The unique number of entitlement plan commitments. -
EntitlementPlanId: integer
(int64)
The unique identifier of entitlement plan of the subscription entitlement plan commitments.
-
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the subscription entitlement plan commitments was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the subscription entitlement plan commitments. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
The login of the user who last updated the subscription entitlement plan commitments. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Read Only:
true
The version number of the subscription entitlement plan commitments. -
Period: string
Title:
Periodicity
The period of the subscription entitlement plan commitments. -
Quantity: number
Title:
Quantity
The quantity of the subscription entitlement plan commitments. -
RelatedChargeDefinitionCode: string
Maximum Length:
30
The charge definition code of the related charge identifier. -
RelatedChargeDefinitionId: integer
(int64)
The unique identifier of charge definition of the related charge.
-
RelatedPeriod: string
Title:
Related Charge Periodicity
The related period of the related charge. Indicates the related charge name from which the estimates or commitments are granted. -
RoundedQuantity: number
Title:
Rounded Quantity
The rounded quantity of the subscription entitlement plan commitments. -
SubscriptionProductId: integer
(int64)
The unique identifier of subscription product of the subscription entitlement plan commitments.
-
UnitOfMeasure: string
Title:
UOM
Maximum Length:3
The unit of measure of the subscription entitlement plan commitments.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.