Get joint venture options
get
/fscmRestApi/resources/11.13.18.05/jointVentureOptions
Request
Query Parameters
-
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 set of joint venture options that matches the primary key criteria specified.
Finder Variables- applicationId; integer; The unique identifier of the Joint Venture Management functional area.
- PrimaryKey Finds the set of joint venture options 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:- applicationId; integer; The unique identifier of the Joint Venture Management functional area.
- carriedInterestEnabledFlag; boolean; Indicates whether carried interest processing is enabled for Joint Venture Management.
- createdBy; string; The user who created the joint venture options.
- creationDate; string; The date and time when the joint venture options were created.
- defaultGeneralLedgerTransactionDate; string; The default transaction date to assign to joint venture transactions when the date from the general ledger transaction date reference isn't found.
- defaultGeneralLedgerTransactionDateDescription; string; The description of the default general ledger transaction date.
- defaultSubledgerAccountingTransactionDate; string; The default transaction date to assign to joint venture transactions when the date from the subledger accounting transaction date reference isn't found.
- defaultSubledgerAccountingTransactionDateDescription; string; The description of the default subledger accounting transaction date.
- emailBody; string; The body of the email used to deliver Joint Interest Billing reports.
- emailSubject; string; The subject line of the email used to deliver Joint Interest Billing reports.
- excludeNonDistributableTransactionsFlag; boolean; Indicates whether to exclude transactions identified as not distributable from Joint Venture Management.
- generalLedgerTransactionDateReference; string; The general ledger date to assign to joint venture transactions as the transaction date.
- lastUpdateDate; string; The date and time when the joint venture options were last updated.
- lastUpdatedBy; string; The user who last updated the joint venture options.
- overrideTaskNumber; string; The overriding task number associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments.
- primarySegmentLabelCode; string; The segment label code used to identify the primary segment that Joint Venture Management uses to identify transactions.
- primarySegmentLabelDescription; string; The description of the primary segment label code.
- projectAttribute; string; The attribute configured in a project's descriptive flexfields that stores the joint venture short name.
- subledgerAccountingExpenditureBusinessUnitIdReference; string; The short name of the supporting reference for subledger accounting that derives an expenditure business unit ID from Project Costing.
- subledgerAccountingExpenditureBusinessUnitIdReferenceDescription; string; The description of the subledger accounting supporting reference for expenditure business unit ID.
- subledgerAccountingExpenditureBusinessUnitIdReferenceName; string; The name of the subledger accounting supporting reference for expenditure business unit ID.
- subledgerAccountingExpenditureItemDateReference; string; The short name of the supporting reference for subledger accounting that derives an expenditure item date from Project Costing.
- subledgerAccountingExpenditureItemDateReferenceDescription; string; The description of the subledger accounting supporting reference for expenditure item date.
- subledgerAccountingExpenditureItemDateReferenceName; string; The name of the subledger accounting supporting reference for expenditure item date.
- subledgerAccountingExpenditureOrganizationIdReference; string; The short name of the supporting reference for subledger accounting that derives an expenditure organization ID from Project Costing.
- subledgerAccountingExpenditureOrganizationIdReferenceDescription; string; The description of the subledger accounting supporting reference for expenditure organization ID.
- subledgerAccountingExpenditureOrganizationIdReferenceName; string; The name of the subledger accounting supporting reference for expenditure organization ID.
- subledgerAccountingExpenditureTypeIdReference; string; The short name of the supporting reference for subledger accounting that derives an expenditure type ID from Project Costing.
- subledgerAccountingExpenditureTypeIdReferenceDescription; string; The description of the subledger accounting supporting reference for expenditure type ID.
- subledgerAccountingExpenditureTypeIdReferenceName; string; The name of the subledger accounting supporting reference for expenditure type ID.
- subledgerAccountingProjectIdReference; string; The short name of the supporting reference for subledger accounting that derives a project ID from Project Costing.
- subledgerAccountingProjectIdReferenceDescription; string; The description of the subledger accounting supporting reference for project ID.
- subledgerAccountingProjectIdReferenceName; string; The name of the subledger accounting supporting reference for project ID.
- subledgerAccountingReferenceDescription; string; The description of the subledger accounting supporting reference.
- subledgerAccountingReferenceName; string; The name of the subledger accounting supporting reference.
- subledgerAccountingTaskIdReference; string; The short name of the supporting reference for subledger accounting that derives a task ID from Project Costing.
- subledgerAccountingTaskIdReferenceDescription; string; The description of the subledger accounting supporting reference for task ID.
- subledgerAccountingTaskIdReferenceName; string; The name of the subledger accounting supporting reference for task ID.
- subledgerAccountingTransactionDateReference; string; The short name of the supporting reference for subledger accounting that derives a transaction date for joint venture transactions.
-
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 : jointVentureOptions
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 : jointVentureOptions-item-response
Type:
Show Source
object
-
applicationId: integer
(int64)
Title:
Application ID
Read Only:true
Default Value:10568
The unique identifier of the Joint Venture Management functional area. -
carriedInterestEnabledFlag: boolean
Title:
Carried Interest Enabled
Maximum Length:1
Indicates whether carried interest processing is enabled for Joint Venture Management. -
createdBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the joint venture options. -
creationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date and time when the joint venture options were created. -
defaultGeneralLedgerTransactionDate: string
Title:
Default GL Transaction Date
The default transaction date to assign to joint venture transactions when the date from the general ledger transaction date reference isn't found. -
defaultGeneralLedgerTransactionDateDescription: string
Title:
Default GL Transaction Date Description
Read Only:true
The description of the default general ledger transaction date. -
defaultSubledgerAccountingTransactionDate: string
Title:
Default SLA Transaction Date
The default transaction date to assign to joint venture transactions when the date from the subledger accounting transaction date reference isn't found. -
defaultSubledgerAccountingTransactionDateDescription: string
Title:
Default SLA Transaction Date Description
Read Only:true
The description of the default subledger accounting transaction date. -
emailBody: string
Title:
Email Message Body
Maximum Length:4000
The body of the email used to deliver Joint Interest Billing reports. -
emailSubject: string
Title:
Email Subject
Maximum Length:250
The subject line of the email used to deliver Joint Interest Billing reports. -
excludeNonDistributableTransactionsFlag: boolean
Title:
Exclude Project Related Transactions That Aren't Distributable
Maximum Length:1
Indicates whether to exclude transactions identified as not distributable from Joint Venture Management. -
generalLedgerReferenceDescription: string
Title:
GL Reference Description
Maximum Length:240
The description of the general ledger date. -
generalLedgerTransactionDateReference: string
Title:
GL Transaction Date Reference
The general ledger date to assign to joint venture transactions as the transaction date. -
lastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date and time when the joint venture options were last updated. -
lastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the joint venture options. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
optionsDFF: array
optionsDFF
-
overrideExpenditureType: string
Title:
Override Expenditure Type Name
The name of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
overrideExpenditureTypeDescription: string
Title:
Override Expenditure Type Description
The description of the overriding expenditure type associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
overrideTaskNumber: string
Title:
Override Task Number
Maximum Length:100
The overriding task number associated with all joint ventures and applied to joint venture distributions sent to Project Costing as cost adjustments. -
primarySegmentLabelCode: string
Title:
Primary Segment Label Code
Maximum Length:30
The segment label code used to identify the primary segment that Joint Venture Management uses to identify transactions. -
primarySegmentLabelDescription: string
Title:
Primary Segment Label Description
Read Only:true
Maximum Length:240
The description of the primary segment label code. -
primarySegmentLabelName: string
Title:
Primary Segment Label Name
The name of the primary segment label code. -
projectAttribute: string
Title:
Project Attribute
The attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
projectAttributeAPIName: string
Title:
Project Attribute API Name
Read Only:true
The API name of the attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
projectAttributeSegment: string
Title:
Project Attribute Segment
Read Only:true
The name of the attribute configured in a project's descriptive flexfields that stores the joint venture short name. -
subledgerAccountingExpenditureBusinessUnitIdReference: string
Title:
SLA Supporting Reference for Expenditure Business Unit ID
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives an expenditure business unit ID from Project Costing. -
subledgerAccountingExpenditureBusinessUnitIdReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Business Unit ID Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference for expenditure business unit ID. -
subledgerAccountingExpenditureBusinessUnitIdReferenceName: string
Title:
SLA Supporting Reference Expenditure Business Unit ID Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference for expenditure business unit ID. -
subledgerAccountingExpenditureItemDateReference: string
Title:
SLA Supporting Reference for Expenditure Item Date
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives an expenditure item date from Project Costing. -
subledgerAccountingExpenditureItemDateReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Item Date Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference for expenditure item date. -
subledgerAccountingExpenditureItemDateReferenceName: string
Title:
SLA Supporting Reference Expenditure Item Date Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference for expenditure item date. -
subledgerAccountingExpenditureOrganizationIdReference: string
Title:
SLA Supporting Reference for Expenditure Organization ID
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives an expenditure organization ID from Project Costing. -
subledgerAccountingExpenditureOrganizationIdReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Organization ID Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference for expenditure organization ID. -
subledgerAccountingExpenditureOrganizationIdReferenceName: string
Title:
SLA Supporting Reference Expenditure Organization ID Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference for expenditure organization ID. -
subledgerAccountingExpenditureTypeIdReference: string
Title:
SLA Supporting Reference for Expenditure Type ID
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives an expenditure type ID from Project Costing. -
subledgerAccountingExpenditureTypeIdReferenceDescription: string
Title:
SLA Supporting Reference Expenditure Type ID Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference for expenditure type ID. -
subledgerAccountingExpenditureTypeIdReferenceName: string
Title:
SLA Supporting Reference Expenditure Type ID Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference for expenditure type ID. -
subledgerAccountingProjectIdReference: string
Title:
SLA Supporting Reference for Project ID
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives a project ID from Project Costing. -
subledgerAccountingProjectIdReferenceDescription: string
Title:
SLA Supporting Reference Project ID Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference for project ID. -
subledgerAccountingProjectIdReferenceName: string
Title:
SLA Supporting Reference Project ID Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference for project ID. -
subledgerAccountingReferenceDescription: string
Title:
SLA Supporting Reference Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference. -
subledgerAccountingReferenceName: string
Title:
SLA Supporting Reference Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference. -
subledgerAccountingTaskIdReference: string
Title:
SLA Supporting Reference for Task ID
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives a task ID from Project Costing. -
subledgerAccountingTaskIdReferenceDescription: string
Title:
SLA Supporting Reference Task ID Description
Read Only:true
Maximum Length:240
The description of the subledger accounting supporting reference for task ID. -
subledgerAccountingTaskIdReferenceName: string
Title:
SLA Supporting Reference Task ID Name
Read Only:true
Maximum Length:80
The name of the subledger accounting supporting reference for task ID. -
subledgerAccountingTransactionDateReference: string
Title:
SLA Supporting Reference for Transaction Date
Maximum Length:30
The short name of the supporting reference for subledger accounting that derives a transaction date for joint venture transactions.
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 : jointVentureOptions-optionsDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
ApplicationId: integer
(int64)
Title:
Application ID
Read Only:true
Default Value:10568
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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 joint venture options 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/jointVentureOptions
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "applicationId": 10568, "generalLedgerTransactionDateReference": "General ledger reference date", "generalLedgerReferenceDescription": "Use the GL reference date as the transaction date on joint venture transactions.", "subledgerAccountingTransactionDateReference": "TRANSACTION_DATE", "subledgerAccountingReferenceName": "JV Transaction Date", "subledgerAccountingReferenceDescription": "Joint venture trasaction date", "createdBy": "username", "creationDate": "2020-04-22T20:39:30+00:00", "lastUpdatedBy": "username", "lastUpdateDate": "2020-05-24T20:25:01+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOptions/10568", "name": "jointVentureOptions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000005178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOptions/10568", "name": "jointVentureOptions", "kind": "item" } ] } ], "count": 1, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureOptions", "name": "jointVentureOptions", "kind": "collection" } ] }