Create a carried interest ownership definition
post
/fscmRestApi/resources/11.13.18.05/carriedInterestAgreements/{agreementId}/child/stakeholderGroups/{stakeholderGroupId}/action/createOwnershipDefinition
Create a carried interest ownership definition based on the specified source ownership definition. The stakeholder percentages defined for the stakeholder group will be used to distribute all nonconsenting stakeholders' percentages to the identified consenting stakeholders in the generated carried interest ownership definition.
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=
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/vnd.oracle.adf.action+json
Root Schema : schema
Type:
Show Source
object
-
assignDefaultOwnershipDefinition: boolean
Indicates whether the carried interest ownership definition is assigned as the default ownership definition for the joint venture assigned to the carried interest agreement.
-
description: string
The description for the carried interest ownership definition.
-
name: string
The name for the carried interest ownership definition.
-
sourceOwnershipDefinition: string
The name of the ownership definition to use as the basis for the carried interest ownership definition.
Response
Supported Media Types
- application/json
- application/vnd.oracle.adf.actionresult+json
Default Response
The following table describes the default response for this task.
Root Schema : schema
Type:
Show Source
object
-
result(required): string
Returns Success if the action completes successfully. Otherwise, a validation exception is generated for the response.