Update one subscription term
patch
/fscmRestApi/resources/11.13.18.05/salesOrdersForOrderHub/{OrderKey}/child/lines/{linesUniqID}/child/subscriptionTerm/{OrderTermId}
Request
Path Parameters
-
OrderKey(required): string
Value that uniquely identifies the sales order. It can have the following formats.
- Concatenation of SourceOrderSystem, a colon, and the value of SourceTransactionId. For orders created through the Oracle Fusion Cloud Order Management work area, the SourceTransactionId is same as the HeaderId. For example, if SourceOrderSystem is LEG and SourceTransactionId is R13_Sample_Order, the value of this attribute is LEG:R13_Sample_Order. This format of the OrderKey in the URL always returns the latest version of the sales order. When a draft exists, that becomes the latest version of the sales order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section point to the latest version of the sales order and the corresponding child objects.
Example: /salesOrdersForOrderHub/LEG:R13_Sample_Order points to the latest version of the order with SourceTransactionId "R13_Sample_Order" in the SourceOrderSystem "LEG".
- Primary key of the sales order, which is HeaderId. This format of the OrderKey is useful when the order has multiple revisions because it helps in accessing either the older version or the latest version of the order. When there's a draft revision then HeaderId can be used to access the processing order. When invoking GET sales order using this OrderKey format, the URLs in the "links" section also point to that specific version of the sales order and the corresponding child objects. Only the Get operation is supported on older revisions of the order.
Example: /salesOrdersForOrderHub/12345 points to an order with HeaderId 12345.
When a q parameter or query finder is used to GET an order that has multiple versions then the latest version has the OrderKey in the format <sourceOrderSystem>:<SourceTransactionId> whereas reference orders have OrderKey in the format of HeaderId. -
OrderTermId(required): integer(int64)
Value that uniquely identifies the term.
-
linesUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Order Lines resource and used to uniquely identify an instance of Order Lines. The client should not generate the hash key value. Instead, the client should query on the Order Lines collection resource in order to navigate to a specific instance of Order Lines to get the hash key.
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
-
OrderTermId: integer
(int64)
Value that uniquely identifies the term.
-
TermAdjustmentPercent: number
Percent of adjustment for the term.
-
TermApplicationMethod: string
Maximum Length:
80
Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod. -
TermApplicationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE. -
TermDuration: number
Duration for the subscription term.
-
TermPeriod: string
Maximum Length:
25
Name of the time unit of measure for the subscription term. -
TermPeriodCode: string
Maximum Length:
15
Abbreviation that identifies the time unit of measure for the subscription term. -
TermStartDate: string
(date-time)
Date when the subscription term starts.
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 : salesOrdersForOrderHub-lines-subscriptionTerm-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderTermId: integer
(int64)
Value that uniquely identifies the term.
-
SourceOrderTermId: string
Maximum Length:
50
Value that uniquely identifies the order term in the source application. For subscription term, the value is 1. -
TermAdjustmentPercent: number
Percent of adjustment for the term.
-
TermApplicationMethod: string
Maximum Length:
80
Method of application for the term. This depends on the type of term. In Oracle Subscription Management Cloud, this attribute is called PricingMethod. -
TermApplicationMethodCode: string
Maximum Length:
30
Abbreviation that identifies the method of application for the term. For a subscription, a list of accepted values is defined in the lookup type ORA_OSS_RNWL_PRICE_ADJ_TYPE. -
TermDuration: number
Duration for the subscription term.
-
TermPeriod: string
Maximum Length:
25
Name of the time unit of measure for the subscription term. -
TermPeriodCode: string
Maximum Length:
15
Abbreviation that identifies the time unit of measure for the subscription term. -
TermStartDate: string
(date-time)
Date when the subscription term starts.
-
TermTypeCode: string
Read Only:
true
Maximum Length:30
Default Value:SUBSCRIPTION
Abbreviation that identifies the type of the term. For subscription term, the TermTypeCode is SUBSCRIPTION.
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.