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

Get all joint venture stakeholders

get

/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders

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
  • 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 joint venture stakeholder that matches the primary key criteria specified.
      Finder Variables:
      • stakeholderId; integer; The unique identifier of the joint venture stakeholder.
    • stakeholderSearch: Finds all joint venture stakeholders.
      Finder Variables:
      • classification; string.
      • costCenterSegmentValue; string; The cost center segment value associated with the joint venture stakeholder.
      • distributionOnlyFlag; string; The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
      • internalStakeholderFlag; string; The flag that indicates whether the joint venture stakeholder is internal or external.
      • invoicingPartnerName; string; The name of the invoicing partner associated with the joint venture stakeholder.
      • partyName; string; The party name associated with the joint venture stakeholder.
      • partyNumber; string; The party number associated with the joint venture stakeholder.
      • searchAllText; string; A search value to identify stakeholders that contain the specified text in any of the string attributes.
      • stakeholderDescription; string; The description of the joint venture stakeholder.
      • stakeholderShortName; string; The name of the joint venture stakeholder.
      • stakeholderStatus; string; The status of the joint venture stakeholder.
      • stakeholderTypeCode; string; The joint venture stakeholder type.
    • validStakeholderSearch: Finds all joint venture stakeholders that are either invoicing partners or cost centers and are eligible to be added to ownership definitions.
      Finder Variables:
    • 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.
    • 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
    • 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.
    • The resource item payload will be filtered in order to contain only data (no links section, for example).
    • 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
    • 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:
      • classification; string; Indicates the classification of a stakeholder as an operator or a nonoperator.
      • costCenterSegmentValue; string; The cost center segment value associated with the joint venture stakeholder.
      • createdBy; string; The user who created the joint venture stakeholder.
      • creationDate; string; The data and time the joint venture stakeholder was created.
      • distributionOnlyFlag; boolean; The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced.
      • internalStakeholderFlag; boolean; The flag that indicates whether the joint venture stakeholder is internal or external.
      • invoicingPartnerName; string; The invoicing partner name associated with the joint venture stakeholder.
      • jibOutputFormat; string; The format of the Joint Interest Billing report output associated with the stakeholder.
      • jibTemplateName; string; The name of the Joint Interest Billing report template associated with the stakeholder.
      • lastUpdateDate; string; The date and time the joint venture stakeholder was last updated.
      • lastUpdatedBy; string; The user who last updated the joint venture stakeholder.
      • partyAddress; string; The address of the party.
      • partyEmail; string; The email address of the party.
      • partyName; string; The name of the party.
      • partyNumber; string; The party number.
      • partyPhone; string; The phone number of the party.
      • preferredCurrencyCode; string; The preferred currency code defined for the stakeholder to use when creating joint venture invoices.
      • stakeholderDescription; string; The description of the joint venture stakeholder.
      • stakeholderId; integer; The unique identifier for joint venture stakeholder.
      • stakeholderShortName; string; The short name of the joint venture stakeholder.
      • stakeholderStatus; string; The status of the joint venture stakeholder.
      • stakeholderTypeCode; string; The joint venture stakeholder type.
    • 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
    • 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-stakeholders
    Type: object
    Show Source
    Nested Schema : Items
    Type: array
    Title: Items
    The items in the collection.
    Show Source
    Nested Schema : jointVentures-stakeholders-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 : Stakeholder Descriptive Flexfields
    Type: array
    Title: Stakeholder Descriptive Flexfields
    The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder.
    Show Source
    Nested Schema : jointVentures-stakeholders-attachments-item-response
    Type: object
    Show Source
    Nested Schema : jointVentures-stakeholders-stakeholderDFF-item-response
    Type: object
    Show Source
    Back to Top

    Examples

    The following example shows how to retrieve all stakeholders 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/stakeholders

    Response Body Example

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

    {
  "items" : [ {
    "costCenterSegmentValue" : null,
    "invoicingPartnerName" : "GASYPROM-IPP1",
    "createdBy" : "username",
    "creationDate" : "2020-01-28T19:48:11+00:00",
    "internalStakeholderFlag" : false,
    "lastUpdateDate" : "2020-01-28T19:48:11.180+00:00",
    "lastUpdatedBy" : "username",
    "stakeholderDescription" : "Geotechnical Partner",
    "stakeholderId" : 300100184768424,
    "stakeholderShortName" : "ACMEXPLORATION",
    "stakeholderStatus" : "Active",
    "stakeholderTypeCode" : null,
    "partyNumber" : "1000",
    "distributionOnlyFlag" : false,
    "partyAddress" : "Munchen Bryggeriet,Soder Malarstrand 27B-29,Stockholm,SE 118 25",
    "partyEmail" : "sendmail-test-discard@oracle.com",
    "partyPhone" : "1-650-5550185",
    "partyName" : "World of Business",
  }, {
    "costCenterSegmentValue" : "112",
    "invoicingPartnerName" : null,
    "createdBy" : "username",
    "creationDate" : "2020-01-28T19:50:01+00:00",
    "internalStakeholderFlag" : true,
    "lastUpdateDate" : "2020-01-28T19:50:01.115+00:00",
    "lastUpdatedBy" : "username",
    "stakeholderDescription" : "Apollo Field services",
    "stakeholderId" : 300100184768426,
    "stakeholderShortName" : "APOLLOTRANS",
    "stakeholderStatus" : "Active",
    "stakeholderTypeCode" : null,
    "partyNumber" : "CDRM_2353",
    "distributionOnlyFlag" : false,
    "partyAddress" : "300 Oracle Parkway,REDWOOD SHORES,CA,94065,US",
    "partyEmail" : null,
    "partyPhone" : null,
    "partyName" : "QTPCustomer_ACCNote4_53020121100001312",
 } ],
  "count" : 2,
  "hasMore" : false,
  "limit" : 25,
  "offset" : 0,
}
    Back to Top