Update a stakeholder percentage
patch
/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/{agreementId}/child/stakeholderGroups/{stakeholderGroupId}/child/stakeholderPercentages/{stakeholderPercentageId}
Request
Path Parameters
-
agreementId(required): integer(int64)
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=
-
stakeholderGroupId(required): integer(int64)
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=
-
stakeholderPercentageId(required): integer(int64)
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
-
carriedInterestAccount: string
Title:
Carried Interest Account
Maximum Length:255
The formatted account combination for the carried interest account used when creating a carried interest journal. -
carriedInterestPercentage: number
Title:
Percentage
The percentage of a nonconsenting stakeholder's interest assumed by a consenting stakeholder. -
consentingStakeholder: string
Title:
Consenting Stakeholder
Maximum Length:80
The name of the consenting stakeholder assuming the interest of a nonconsenting stakeholder. -
consentingStakeholderDescription: string
Title:
Description
Maximum Length:240
The description of the consenting stakeholder assuming the interest of a nonconsenting stakeholder. -
createJournalsFlag: boolean
Title:
Create Journals
Maximum Length:1
Indicates whether carried interest journals are created for carried interest distributions for the consenting stakeholder. -
nonConsentingStakeholder: string
Title:
Nonconsenting Stakeholder
Maximum Length:240
The name of the nonconsenting stakeholder. -
nonConsentingStakeholderDescription: string
Title:
Description
Maximum Length:240
The description of the nonconsenting stakeholder. -
stakeholderPercentageDFF: array
stakeholderPercentageDFF
Nested Schema : schema
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
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 : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-item-response
Type:
Show Source
object
-
carriedInterestAccount: string
Title:
Carried Interest Account
Maximum Length:255
The formatted account combination for the carried interest account used when creating a carried interest journal. -
carriedInterestPercentage: number
Title:
Percentage
The percentage of a nonconsenting stakeholder's interest assumed by a consenting stakeholder. -
consentingStakeholder: string
Title:
Consenting Stakeholder
Maximum Length:80
The name of the consenting stakeholder assuming the interest of a nonconsenting stakeholder. -
consentingStakeholderDescription: string
Title:
Description
Maximum Length:240
The description of the consenting stakeholder assuming the interest of a nonconsenting stakeholder. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the resource item. -
createJournalsFlag: boolean
Title:
Create Journals
Maximum Length:1
Indicates whether carried interest journals are created for carried interest distributions for the consenting stakeholder. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the resource item was created. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the resource item was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the resource item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
nonConsentingStakeholder: string
Title:
Nonconsenting Stakeholder
Maximum Length:240
The name of the nonconsenting stakeholder. -
nonConsentingStakeholderDescription: string
Title:
Description
Maximum Length:240
The description of the nonconsenting stakeholder. -
stakeholderPercentageDFF: array
stakeholderPercentageDFF
-
stakeholderPercentageId: integer
(int64)
Title:
Stakeholder Percentage ID
Read Only:true
The unique identifier of the stakeholder percentage. -
structureInstanceNumber: integer
(int64)
Title:
Structure Instance Number
Read Only:true
The unique identifier of the chart of accounts assigned to the primary ledger of the business unit associated with the joint venture.
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.
Nested Schema : carriedInterestAgreements-stakeholderGroups-stakeholderPercentages-stakeholderPercentageDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
GroupLineId: integer
(int64)
Title:
Stakeholder Group Line ID
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- stakeholderPercentageDFF
-
Parameters:
- agreementId:
$request.path.agreementId
- stakeholderGroupId:
$request.path.stakeholderGroupId
- stakeholderPercentageId:
$request.path.stakeholderPercentageId
- agreementId: