Create a set of ownership percentage for an ownership definition
post
/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}/child/ownershipPercentages
Request
Path Parameters
-
jointVentureId(required): integer(int64)
The unique identifier of the joint venture.
-
ownershipDefinitionId(required): integer(int64)
The unique identifier of the ownership definition.
Header Parameters
-
Metadata-Context: string
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: string
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.
-
Upsert-Mode: string
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
distributionOnlyFlag: boolean
Title:
Distribution OnlyMaximum Length:1Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced. -
ownershipPercentageDFF: array
Ownership Percentage Descriptive Flexfields
Title:
Ownership Percentage Descriptive FlexfieldsThe ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition. -
percentageOfInterest: number
Title:
Ownership PercentageDefault Value:0The percent of ownership a stakeholder has in a joint venture transaction. -
roundingPartnerFlag: boolean
Title:
Rounding PartnerMaximum Length:1Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner. -
stakeholderName: string
Title:
StakeholderThe name of the joint venture stakeholder.
Nested Schema : Ownership Percentage Descriptive Flexfields
Type:
arrayTitle:
Ownership Percentage Descriptive FlexfieldsThe ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150The descriptive flexfield context name for the ownership percentage associated with the ownership definition. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentThe descriptive flexfield context display value for the ownership percentage associated with the ownership definition. -
OwnershipLineId: integer
(int64)
The unique identifier of the ownership percentage.
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 : jointVentures-ownershipDefinitions-ownershipPercentages-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the ownership percentage. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the ownership percentage was created. -
distributionOnlyFlag: boolean
Title:
Distribution OnlyMaximum Length:1Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced. -
internalStakeholderFlag: boolean
Title:
Stakeholder TypeRead Only:trueMaximum Length:1Indicates that the joint venture stakeholder is an internal stakeholder. -
invoicingPartnerId: integer
(int64)
Title:
Invoicing Partner IDRead Only:trueThe unique identifier of the invoicing partner. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time the ownership percentage was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the ownership percentage. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
ownershipDefinitionName: string
Title:
Ownership DefinitionRead Only:trueMaximum Length:30The name of the ownership definition. -
ownershipPercentageDFF: array
Ownership Percentage Descriptive Flexfields
Title:
Ownership Percentage Descriptive FlexfieldsThe ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition. -
ownershipPercentageId: integer
(int64)
Title:
Ownership Percentage IDRead Only:trueThe unique identifier of the ownership percentage. -
percentageOfInterest: number
Title:
Ownership PercentageDefault Value:0The percent of ownership a stakeholder has in a joint venture transaction. -
roundingPartnerFlag: boolean
Title:
Rounding PartnerMaximum Length:1Indicates that the joint venture stakeholder is the rounding partner, receiving any extra cost or revenue after the split. Only one stakeholder in an ownership definition can be the rounding partner. -
stakeholderDescription: string
Title:
DescriptionRead Only:trueMaximum Length:240The description of the joint venture stakeholder. -
stakeholderName: string
Title:
StakeholderThe name of the joint venture stakeholder.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : Ownership Percentage Descriptive Flexfields
Type:
arrayTitle:
Ownership Percentage Descriptive FlexfieldsThe ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150The descriptive flexfield context name for the ownership percentage associated with the ownership definition. -
__FLEX_Context_DisplayValue: string
Title:
Context SegmentThe descriptive flexfield context display value for the ownership percentage associated with the ownership definition. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
OwnershipLineId: integer
(int64)
The unique identifier of the ownership percentage.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- ownershipPercentageDFF
-
Parameters:
- jointVentureId:
$request.path.jointVentureId - ownershipDefinitionId:
$request.path.ownershipDefinitionId - ownershipPercentageId:
$request.path.ownershipPercentageId
The ownership percentage descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership percentage associated with an ownership definition. - jointVentureId:
Examples
The following example shows how to specify an ownership percentage for a stakeholder by submitting a POST request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d @JVOwnershipPercentCreate.json https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100184768422/child/ownershipDefinitions/300100184768458/child/ownershipPercentages
Request Body Example
The following shows an example of the request body in JSON format.
{
"distributionOnlyFlag" : false,
"percentageOfInterest" : 10,
"roundingPartnerFlag" : true,
"stakeholderName" : "APOLLOTRANS"
}
Response Body Example
The following shows an example of the response body in JSON format.
{
"createdBy" : "username",
"creationDate" : "2020-02-14T22:35:49+00:00",
"distributionOnlyFlag" : false,
"lastUpdateDate" : "2020-02-14T22:35:49.001+00:00",
"lastUpdatedBy" : "username",
"ownershipPercentageId" : 300100184961473,
"percentageOfInterest" : 10,
"roundingPartnerFlag" : true,
"invoicingPartnerId" : null,
"internalStakeholderFlag" : true,
"stakeholderName" : "APOLLOTRANS",
"stakeholderDescription" : "Apollo Field services",
"ownershipDefinitionName" : "BASINOD",
}