Get all ownership definitions associated with a joint venture
get
/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions
Request
Path Parameters
-
jointVentureId(required): integer(int64)
The unique identifier of the joint venture.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the ownership definition that matches the primary key criteria specified.
Finder Variables:- ownershipDefinitionId; integer; The unique identifier of the ownership definition.
- ownerDefinHeaderSearch: Finds all ownership definitions associated with a joint venture.
Finder Variables:- agreement; string.
- effectiveEndDate; string; The end date of the effective date range of the ownership definition.
- effectiveStartDate; string; The start date of the effective date range of the ownership definition.
- jointVentureName; string; The name of the joint venture.
- ownershipDefinitionDescription; string; A description of the ownership definition.
- ownershipDefinitionShortName; string; The short name of the ownership definition that is used as an identifier across effective dates for the joint venture.
- ownershipDefinitionStatus; string; The status of the ownership definition.
- searchAllText; string; A search value to identify ownership definitions that contain the specified text in any of the string attributes.
- PrimaryKey: Finds the ownership definition that matches the primary key criteria specified.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- activeFlag; boolean; Indicates whether the ownership definition is active or not.
- agreement; string; The name of the carried interest agreement.
- changeReason; string; Indicates the reason for changing the effective dates on the ownership definition.
- changeReasonAdditionalText; string; Additional information describing the reason for changing the ownership definition.
- createdBy; string; The user who created the ownership definition.
- creationDate; string; The date and time the ownership definition was created.
- defaultOwnershipDefinitionFlag; boolean; Indicates that the ownership definition is the default ownership definition of the joint venture.
- effectiveEndDate; string; The end date of the effective date range of the ownership definition.
- effectiveStartDate; string; The start date of the effective date range of the ownership definition.
- externalStakeholderExistsFlag; boolean; Indicates that the ownership definition has at least one external stakeholder.
- internalStakeholderExistsFlag; boolean; Indicates that the ownership definition has at least one internal stakeholder.
- jointVentureDescription; string; The description of the joint venture.
- jointVentureName; string; The name of the joint venture.
- lastUpdateDate; string; The date and time the ownership definition was last updated.
- lastUpdatedBy; string; The user who last updated the ownership definition.
- ownershipChangeFlag; boolean; Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled.
- ownershipDefinitionDescription; string; A description of the ownership definition.
- ownershipDefinitionId; integer; The unique identifier of the ownership definition.
- ownershipDefinitionShortName; string; The short name of the ownership definition that is used as an identifier across effective dates for the joint venture.
- ownershipDefinitionStatus; string; The status of the ownership definition.
- ownershipVersion; integer; The version number of the ownership definition.
- sourceOwnershipDefinition; string; The name of the ownership definition used as the basis for creating the carried interest ownership definition.
- sourceOwnershipDefinitionDescription; string; The description of the ownership definition used as the basis for creating the carried interest ownership definition.
- stakeholderGroup; string; The name of the stakeholder group associated with the carried interest ownership definition.
- stakeholderGroupDescription; string; The description of the stakeholder group associated with the carried interest ownership definition.
- totalPercentage; number; The sum of all percentages of ownership in the ownership definition.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentures-ownershipDefinitions-item-response
Type:
Show Source
object
-
activeFlag: boolean
Title:
Invoicing Partner Active
Read Only:true
Indicates whether the ownership definition is active or not. -
agreement: string
Title:
Agreement
Read Only:true
Maximum Length:30
The name of the carried interest agreement. -
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
changeReason: string
Title:
Change Reason
Maximum Length:255
Indicates the reason for changing the effective dates on the ownership definition. -
changeReasonAdditionalText: string
Title:
Change Reason Additional Information
Maximum Length:240
Additional information describing the reason for changing the ownership definition. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the ownership definition. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time the ownership definition was created. -
defaultOwnershipDefinitionFlag: boolean
Title:
Default Ownership Definition
Read Only:true
Indicates that the ownership definition is the default ownership definition of the joint venture. -
distributionExist: string
Title:
Distributions Exist
Read Only:true
Indicates whether joint venture distributions exist for the ownership definition. -
effectiveEndDate: string
(date)
Title:
End Date
The end date of the effective date range of the ownership definition. -
effectiveStartDate: string
(date)
Title:
Start Date
The start date of the effective date range of the ownership definition. -
externalStakeholderExistsFlag: boolean
Title:
External Stakeholder Exists
Read Only:true
Indicates that the ownership definition has at least one external stakeholder. -
internalStakeholderExistsFlag: boolean
Title:
Internal Stakeholder Exists
Read Only:true
Indicates that the ownership definition has at least one internal stakeholder. -
jointVentureDescription: string
Title:
Joint Venture Description
Read Only:true
Maximum Length:240
The description of the joint venture. -
jointVentureName: string
Title:
Joint Venture Name
Read Only:true
Maximum Length:30
The name of the joint venture. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the ownership definition was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the ownership definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ownershipChangeFlag: boolean
Title:
Ownership Definition Changed
Read Only:true
Maximum Length:1
Default Value:false
Indicates whether the ownership definition has changed and the associated joint venture distributions need to be rebilled. -
ownershipDefinitionDescription: string
Title:
Description
Maximum Length:240
A description of the ownership definition. -
ownershipDefinitionDFF: array
Ownership Definition Descriptive Flexfields
Title:
Ownership Definition Descriptive Flexfields
The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture. -
ownershipDefinitionId: integer
(int64)
Title:
Ownership Definition ID
Read Only:true
The unique identifier of the ownership definition. -
ownershipDefinitionShortName: string
Title:
Ownership Definition
Maximum Length:30
The short name of the ownership definition that is used as an identifier across effective dates for the joint venture. -
ownershipDefinitionStatus: string
Title:
Status
Maximum Length:255
The status of the ownership definition. -
ownershipPercentages: array
Ownership Percentages
Title:
Ownership Percentages
The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition. -
ownershipVersion: integer
(int32)
Title:
Ownership Definition Version
Read Only:true
The version number of the ownership definition. -
sourceOwnershipDefinition: string
Title:
Source Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition used as the basis for creating the carried interest ownership definition. -
sourceOwnershipDefinitionDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the ownership definition used as the basis for creating the carried interest ownership definition. -
stakeholderGroup: string
Title:
Stakeholder Group
Read Only:true
Maximum Length:30
The name of the stakeholder group associated with the carried interest ownership definition. -
stakeholderGroupDescription: string
Title:
Description
Read Only:true
Maximum Length:240
The description of the stakeholder group associated with the carried interest ownership definition. -
totalPercentage: number
Title:
Total Percentage
Read Only:true
The sum of all percentages of ownership in the ownership definition.
Nested Schema : Attachments
Type:
array
Title:
Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Ownership Definition Descriptive Flexfields
Type:
array
Title:
Ownership Definition Descriptive Flexfields
The ownership definition descriptive flexfields resource is used to manage details about the descriptive flexfield references for an ownership definition associated with a joint venture.
Show Source
Nested Schema : Ownership Percentages
Type:
array
Title:
Ownership Percentages
The ownership percentages resource is used to view, create, update, or delete each stakeholder???s percentage of ownership in an ownership definition. The percentages must total 100 percent for all stakeholders in the ownership definition.
Show Source
Nested Schema : jointVentures-ownershipDefinitions-attachments-item-response
Type:
Show Source
object
-
AsyncTrackerId: string
Title:
Asynchronous Upload Tracker Id
Attribute provided for the exclusive use by the Attachment UI components to assist in uploading files. -
AttachedDocumentId: integer
(int64)
Title:
Attached Document Id
The unique identifier of the attached document. -
CategoryName: string
Title:
Category
Maximum Length:30
The category of the attachment. - ContentRepositoryFileShared: boolean
-
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:255
The user who created the record. -
CreatedByUserName: string
Title:
Created By User Name
Read Only:true
The user name who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DatatypeCode: string
Title:
Type
Maximum Length:30
Default Value:FILE
A value that indicates the data type. -
Description: string
Title:
Description
Maximum Length:255
The description of the attachment. -
DmDocumentId: string
Maximum Length:
255
The document ID from which the attachment is created. -
DmFolderPath: string
Title:
Dm Folder Path
Maximum Length:1000
The folder path from which the attachment is created. -
DmVersionNumber: string
Maximum Length:
255
The document version number from which the attachment is created. -
DownloadInfo: string
Title:
DownloadInfo
JSON object represented as a string containing information used to programmatically retrieve a file attachment. -
ErrorStatusCode: string
Title:
Error Status Code
The error code, if any, for the attachment. -
ErrorStatusMessage: string
Title:
Error Status Message
The error message, if any, for the attachment. -
ExpirationDate: string
(date-time)
Title:
Expiration Date
The expiration date of the contents in the attachment. -
FileContents: string
(byte)
Title:
File Contents
The contents of the attachment. -
FileName: string
Title:
File Name
Maximum Length:2048
The file name of the attachment. -
FileUrl: string
Title:
File Url
The URI of the file. -
FileWebImage: string
(byte)
Title:
File Web Image
Read Only:true
The base64 encoded image of the file displayed in .png format if the source is a convertible image. -
LastUpdateDate: string
(date-time)
Title:
Last Update Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:255
The user who last updated the record. -
LastUpdatedByUserName: string
Title:
Last Updated By User
Read Only:true
The user name who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PostProcessingAction: string
Title:
PostProcessingAction
The name of the action that can be performed after an attachment is uploaded. -
Title: string
Title:
Title
The title of the attachment. -
UploadedFileContentType: string
Title:
Uploaded File Content Type
The content type of the attachment. -
UploadedFileLength: integer
Title:
File Size
The size of the attachment file. -
UploadedFileName: string
Title:
Uploaded File Name
The name to assign to a new attachment file. -
UploadedText: string
Title:
Uploaded Text
The text content for a new text attachment. -
Uri: string
Title:
Uri
Maximum Length:4000
The URI of a Topology Manager type attachment. -
Url: string
Title:
Url
Maximum Length:4000
The URL of a web page type attachment. -
UserName: string
Title:
User Name
Read Only:true
Maximum Length:255
The login credentials of the user who created the attachment.
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 : jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The descriptive flexfield context name for the ownership definition associated with the joint venture. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The descriptive flexfield context display value for the ownership definition associated with the joint venture. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnershipPercentageId: integer
(int64)
The unique identifier of the ownership definition.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : jointVentures-ownershipDefinitions-ownershipPercentages-item-response
Type:
Show Source
object
-
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the ownership percentage. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the ownership percentage was created. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
Indicates that the joint venture stakeholder is only participating in the transaction distribution and is not being invoiced. -
internalStakeholderFlag: boolean
Title:
Stakeholder Type
Read Only:true
Maximum Length:1
Indicates that the joint venture stakeholder is an internal stakeholder. -
invoicingPartnerId: integer
(int64)
Title:
Invoicing Partner ID
Read Only:true
The unique identifier of the invoicing partner. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the ownership percentage was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the ownership percentage. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ownershipDefinitionName: string
Title:
Ownership Definition
Read Only:true
Maximum Length:30
The name of the ownership definition. -
ownershipPercentageDFF: array
Ownership Percentage Descriptive Flexfields
Title:
Ownership Percentage Descriptive Flexfields
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. -
ownershipPercentageId: integer
(int64)
Title:
Ownership Percentage ID
Read Only:true
The unique identifier of the ownership percentage. -
percentageOfInterest: number
Title:
Ownership Percentage
Default Value:0
The percent of ownership a stakeholder has in a joint venture transaction. -
roundingPartnerFlag: boolean
Title:
Rounding Partner
Maximum Length:1
Indicates 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:
Description
Read Only:true
Maximum Length:240
The description of the joint venture stakeholder. -
stakeholderName: string
Title:
Stakeholder
The name of the joint venture stakeholder.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Ownership Percentage Descriptive Flexfields
Type:
array
Title:
Ownership Percentage Descriptive Flexfields
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.
Show Source
Nested Schema : jointVentures-ownershipDefinitions-ownershipPercentages-ownershipPercentageDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The descriptive flexfield context name for the ownership percentage associated with the ownership definition. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The descriptive flexfield context display value for the ownership percentage associated with the ownership definition. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OwnershipLineId: integer
(int64)
The unique identifier of the ownership percentage.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Examples
The following example shows how to retrieve multiple ownership definitions by submitting a GET request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourcecollection+json" -X GET https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentures/300100184768422/child/ownershipDefinitions
Response Body Example
The following shows an example of the response body in JSON format.
{ "items" : [ { "createdBy" : "username", "creationDate" : "2020-01-28T19:51:56+00:00", "effectiveEndDate" : "2006-12-31", "effectiveStartDate" : "2006-01-01", "lastUpdateDate" : "2020-01-28T20:54:00+00:00", "lastUpdatedBy" : "username", "ownershipDefinitionDescription" : "Ownership definition for the Apollo Basin Project", "ownershipDefinitionShortName" : "BASINOD", "ownershipDefinitionId" : 300100184768427, "jointVentureDescription" : "Oklahoma panhandle project.\nLot32, Parcel 1TR5-A", "ownershipDefinitionStatus" : "Active", "jointVentureName" : "APOLLOBASIN", "defaultOwnershipDefinitionFlag" : true, "totalPercentage" : 100, "internalStakeholderExistsFlag" : true, "externalStakeholderExistsFlag" : true, "activeFlag" : true, }, { "createdBy" : "username", "creationDate" : "2020-01-29T13:15:55+00:00", "effectiveEndDate" : "2007-12-31", "effectiveStartDate" : "2007-01-01", "lastUpdateDate" : "2020-01-29T13:16:07.084+00:00", "lastUpdatedBy" : "username", "ownershipDefinitionDescription" : "Ownership definition for the Apollo Basin Project", "ownershipDefinitionShortName" : "BASINOD", "ownershipDefinitionId" : 300100184768458, "jointVentureDescription" : "Oklahoma panhandle project.\nLot32, Parcel 1TR5-A", "ownershipDefinitionStatus" : "Pending", "jointVentureName" : "APOLLOBASIN", "defaultOwnershipDefinitionFlag" : true, "totalPercentage" : 42, "internalStakeholderExistsFlag" : true, "externalStakeholderExistsFlag" : true, "activeFlag" : false, } ], "count" : 2, "hasMore" : false, "limit" : 25, "offset" : 0,