Get all joint venture stakeholders
get
/fscmRestApi/resources/11.13.18.05/jointVentures/{jointVentureId}/child/stakeholders
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 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:
- PrimaryKey: Finds the joint venture stakeholder 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:- 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.
-
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-stakeholders
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-stakeholders-item-response
Type:
Show Source
object
-
attachments: array
Attachments
Title:
Attachments
The attachments resource is used to view, create, and update attachments. -
classification: string
Title:
Classification
Indicates the classification of a stakeholder as an operator or a nonoperator. -
costCenterSegmentValue: string
Title:
Cost Center
Maximum Length:25
The cost center segment value associated with the joint venture stakeholder. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture stakeholder. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The data and time the joint venture stakeholder was created. -
distributionOnlyFlag: boolean
Title:
Distribution Only
Maximum Length:1
The flag that indicates whether the joint venture stakeholder is only participating in the transaction distribution and not being invoiced. -
internalStakeholderFlag: boolean
Title:
Stakeholder Type
Maximum Length:1
The flag that indicates whether the joint venture stakeholder is internal or external. -
invoicingPartnerName: string
Title:
Invoicing Partner
Maximum Length:255
The invoicing partner name associated with the joint venture stakeholder. -
jibOutputFormat: string
Title:
Joint Interest Billing Report Output Format
The format of the Joint Interest Billing report output associated with the stakeholder. -
jibTemplateName: string
Title:
Joint Interest Billing Report Template
Maximum Length:100
The name of the Joint Interest Billing report template associated with the stakeholder. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time the joint venture stakeholder was last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture stakeholder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
partyAddress: string
Title:
Party Address
Maximum Length:960
The address of the party. -
partyEmail: string
Title:
Party Email
Maximum Length:255
The email address of the party. -
partyName: string
Title:
Contact Person
Maximum Length:255
The name of the party. -
partyNumber: string
Title:
Party Number
Maximum Length:255
The party number. -
partyPhone: string
Title:
Party Phone
The phone number of the party. -
preferredCurrencyCode: string
Title:
Preferred Currency
Maximum Length:15
The preferred currency code defined for the stakeholder to use when creating joint venture invoices. -
stakeholderDescription: string
Title:
Description
Maximum Length:240
The description of the joint venture stakeholder. -
stakeholderDFF: array
Stakeholder Descriptive Flexfields
Title:
Stakeholder Descriptive Flexfields
The stakeholder descriptive flexfields resource is used to manage details about the descriptive flexfield references for a joint venture stakeholder. -
stakeholderId: integer
(int64)
Title:
Stakeholder ID
Read Only:true
The unique identifier for joint venture stakeholder. -
stakeholderShortName: string
Title:
Stakeholder
Maximum Length:30
The short name of the joint venture stakeholder. -
stakeholderStatus: string
Title:
Status
Maximum Length:255
The status of the joint venture stakeholder. -
stakeholderTypeCode: string
Title:
Stakeholder Category
Maximum Length:255
The joint venture stakeholder type.
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 : 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:
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-stakeholders-stakeholderDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
The descriptive flexfield context name for the joint venture stakeholder. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
The descriptive flexfield context display value for the joint venture stakeholder. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
StakeholderId: integer
(int64)
The unique identifier of the joint venture stakeholder.
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 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, }