1. REST API for Oracle Fusion Cloud Financials
  2. Tasks
  3. Joint Ventures
  4. Ownership Definitions

Get an ownership definition

get

/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/ownershipDefinitions/{ownershipDefinitionId}

Request

Path Parameters
Query Parameters
  • 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>
  • 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).
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
  • 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".
  • 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 Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : jointVentures-ownershipDefinitions-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
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: object
Show Source
Nested Schema : jointVentures-ownershipDefinitions-ownershipDefinitionDFF-item-response
Type: object
Show Source
Nested Schema : jointVentures-ownershipDefinitions-ownershipPercentages-item-response
Type: object
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: object
Show Source
Links
attachments
Parameters:
  • jointVentureId: $request.path.jointVentureId
  • ownershipDefinitionId: $request.path.ownershipDefinitionId
The attachments resource is used to view, create, and update attachments.
ownershipDefinitionDFF
Parameters:
  • jointVentureId: $request.path.jointVentureId
  • ownershipDefinitionId: $request.path.ownershipDefinitionId
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.
ownershipPercentages
Parameters:
  • jointVentureId: $request.path.jointVentureId
  • ownershipDefinitionId: $request.path.ownershipDefinitionId
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.
Back to Top

Examples

The following example shows how to retrieve an ownership definition 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/300100184768427

Response Body Example

The following shows an example of the response body in JSON format.

{
  "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,
}
Back to Top