Update a revenue plan translation
patch
/fscmRestApi/resources/11.13.18.05/contracts/{contractsUniqID}/child/RevenuePlan/{RevenuePlanUniqID}/child/RevenuePlanTranslation/{RevenuePlanTranslationUniqID}
Request
Path Parameters
-
RevenuePlanTranslationUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BillPlanId, MajorVersion and Language ---for the Revenue Plan Translations resource and used to uniquely identify an instance of Revenue Plan Translations. The client should not generate the hash key value. Instead, the client should query on the Revenue Plan Translations collection resource with a filter on the primary key values in order to navigate to a specific instance of Revenue Plan Translations.
For example: RevenuePlanTranslation?q=BillPlanId=<value1>;MajorVersion=<value2>;Language=<value3> -
RevenuePlanUniqID(required): string
This is the hash key of the attributes which make up the composite key--- BillPlanId and MajorVersion ---for the Revenue Plans resource and used to uniquely identify an instance of Revenue Plans. The client should not generate the hash key value. Instead, the client should query on the Revenue Plans collection resource with a filter on the primary key values in order to navigate to a specific instance of Revenue Plans.
For example: RevenuePlan?q=BillPlanId=<value1>;MajorVersion=<value2> -
contractsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Contracts resource and used to uniquely identify an instance of Contracts. The client should not generate the hash key value. Instead, the client should query on the Contracts collection resource in order to navigate to a specific instance of Contracts 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
-
BillPlanDesc: string
Maximum Length:
240
The revenue plan description. -
BillPlanId: integer
(int64)
Bill Plan Identifier
-
BillPlanName: string
Maximum Length:
30
Bill Plan Name -
InvoiceComment: string
Maximum Length:
240
Comments of the Invoice -
InvoiceInstructions: string
Maximum Length:
240
Invoice Instructions -
Language: string
Maximum Length:
4
Translation Language -
MajorVersion: integer
(int64)
Contract version of the Bill Plan Translation
-
ObjectVersionNumber: integer
(int32)
The revenue plan object version.
-
SourceLang: string
Maximum Length:
4
Source Language
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 : contracts-RevenuePlan-RevenuePlanTranslation-item-response
Type:
Show Source
object
-
BillPlanDesc: string
Maximum Length:
240
The revenue plan description. -
BillPlanId: integer
(int64)
Bill Plan Identifier
-
BillPlanName: string
Maximum Length:
30
Bill Plan Name -
InvoiceComment: string
Maximum Length:
240
Comments of the Invoice -
InvoiceInstructions: string
Maximum Length:
240
Invoice Instructions -
Language: string
Maximum Length:
4
Translation Language -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorVersion: integer
(int64)
Contract version of the Bill Plan Translation
-
ObjectVersionNumber: integer
(int32)
The revenue plan object version.
-
SourceLang: string
Maximum Length:
4
Source Language
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.