Jump to

• Request
• Response
• Examples

Get all joint venture partner contribution requests

get

/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests

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 joint venture partner contribution request; string; that matches the primary key criteria specified.
    Finder Variables
    • contributionRequestId; integer; The unique identifier of the partner contribution request; string; .
  • contributionRequestFinder Finds all joint venture partner contribution requests that match the specified search criteria.
    Finder Variables
    • endDate; string; The end date of the joint venture partner contribution request; string; .
    • jointVenture; string; The unique name of the joint venture.
    • ownershipDefinition; string; The name of the ownership definition.
    • request; string; The unique name of the joint venture partner contribution request; string; .
    • requestDescription; string; The description of the joint venture partner contribution request; string; .
    • runDay; string; The run day of the joint venture partner contribution request; string; , for example, the first day of the following week, last day of the current week, first day of the following month, or last day of the current month.
    • searchAllText; string; A search value to identify joint venture contribution requests that contain the specified text in any of the string attributes.
    • stakeholder; string; The unique name of the joint venture stakeholder; string; .
    • startDate; string; The start date of the joint venture partner contribution request; string; .
    • status; string; The status; string; of the joint venture partner contribution request; string; .
• 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:
  

  • contributionAccount; string; The combination of segment values for a joint venture partner contribution account.
  • contributionRequestId; integer; The unique identifier of the partner contribution request.
  • conversionDate; string; The date used when retrieving the currency conversion rate for the partner contribution request.
  • createdBy; string; The user who created the resource item.
  • creationDate; string; The date and time when the resource item was created.
  • currencyCode; string; The currency code used to create partner contributions from a request.
  • endDate; string; The end date of the joint venture partner contribution request.
  • frequency; string; The frequency of processing partner contribution requests.
  • jointVenture; string; The unique name of the joint venture.
  • jointVentureDescription; string; The description of the joint venture.
  • lastRunDate; string; The date the partner contribution request was last processed successfully.
  • lastUpdateDate; string; The date and time when the resource item was last updated.
  • lastUpdatedBy; string; The user who last updated the resource item.
  • openDistributionAmountFlag; boolean; Indicates whether the amounts for the partner contributions are based on the open distribution amounts for the stakeholders.
  • ownershipDefinition; string; The name of the ownership definition.
  • request; string; The unique name of the joint venture partner contribution request.
  • requestDescription; string; The description of the joint venture partner contribution request.
  • requestedGrossAmount; number; The gross amount on the partner contribution request from which partner contributions will be created.
  • runDay; string; The run day of the joint venture partner contribution request, for example, the first day of the following week, last day of the current week, first day of the following month, or last day of the current month.
  • stakeholder; string; The unique name of the joint venture stakeholder.
  • startDate; string; The start date of the joint venture partner contribution request.
  • status; string; The status of the joint venture partner contribution request.
  • weekEndDay; string; The ending day of the week on the partner contribution request that's used when creating weekly partner contributions.
  • weekStartDay; string; The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.
• 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 Top

Response

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.

Body ()

Root Schema : jointVentureContributionRequests

Type: object

Show Source

• 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.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributionRequests-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object jointVentureContributionRequests-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributionRequests-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureContributionRequests-item-response

Type: object

Show Source

• contributionAccount: string
  Title: Joint Venture Partner Contribution Account

  The combination of segment values for a joint venture partner contribution account.
• contributionRequestDFF: array contributionRequestDFF
• contributionRequestId: integer (int64)
  Title: Contribution Request ID

  Read Only: true

  The unique identifier of the partner contribution request.
• contributionsExistFlag: boolean
  Title: Partner Contribution Exists

  Read Only: true

  Indicates whether there are existing partner contributions for the request.
• conversionDate: string
  Title: Conversion Date

  The date used when retrieving the currency conversion rate for the partner contribution request.
• createdBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the resource item.
• creationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the resource item was created.
• currencyCode: string
  Title: Currency

  Maximum Length: 15

  The currency code used to create partner contributions from a request.
• endDate: string (date)
  Title: End Date

  The end date of the joint venture partner contribution request.
• frequency: string
  Title: Frequency

  The frequency of processing partner contribution requests.
• jointVenture: string
  Title: Joint Venture

  The unique name of the joint venture.
• jointVentureDescription: string
  Title: Joint Venture Description

  The description of the joint venture.
• lastRunDate: string (date)
  Title: Last Run Date

  Read Only: true

  The date the partner contribution request was last processed successfully.
• lastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the resource item was last updated.
• lastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the resource item.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• openDistributionAmountFlag: boolean
  Title: Use Open Distribution Amount

  Maximum Length: 1

  Default Value: false

  Indicates whether the amounts for the partner contributions are based on the open distribution amounts for the stakeholders.
• ownershipDefinition: string
  Title: Ownership Definition

  Maximum Length: 30

  The name of the ownership definition.
• request: string
  Title: Partner Contribution Request

  Maximum Length: 30

  The unique name of the joint venture partner contribution request.
• requestDescription: string
  Title: Description

  Maximum Length: 240

  The description of the joint venture partner contribution request.
• requestedGrossAmount: number
  Title: Requested Amount

  The gross amount on the partner contribution request from which partner contributions will be created.
• runDay: string
  Title: Run Day

  The run day of the joint venture partner contribution request, for example, the first day of the following week, last day of the current week, first day of the following month, or last day of the current month.
• stakeholder: string
  Title: Direct Billed Stakeholder

  The unique name of the joint venture stakeholder.
• startDate: string (date)
  Title: Start Date

  The start date of the joint venture partner contribution request.
• status: string
  Title: Status

  The status of the joint venture partner contribution request.
• structureInstanceNumber: integer
  Title: Structure Instance Number

  The chart of accounts instance number associated with the joint venture's business unit.
• weekEndDay: string
  Title: End Day

  The ending day of the week on the partner contribution request that's used when creating weekly partner contributions.
• weekStartDay: string
  Title: Start Day

  The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.

{
    "type":"object",
    "properties":{
        "request":{
            "title":"Partner Contribution Request",
            "maxLength":30,
            "type":"string",
            "description":"The unique name of the joint venture partner contribution request.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "endDate":{
            "title":"End Date",
            "type":"string",
            "description":"The end date of the joint venture partner contribution request.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "lastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource item was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "contributionAccount":{
            "title":"Joint Venture Partner Contribution Account",
            "type":"string",
            "description":"The combination of segment values for a joint venture partner contribution account.",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ResourceLOVName":"accountCombinationsLOV",
                "FND_ACFF_ResourceLOVFinderContext":"oracle.apps.financials.jointVenture.invoicing.model.view.ContributionRequestVO#partnerAccount",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "FND_ACFF_ResourceName":"jointVentureContributionRequests",
                "ojStructureInstanceNumber":"structureInstanceNumber"
            },
            "x-oj":{
                "controlType":"oj-sp-input-key-flex-field"
            },
            "x-queryable":true
        },
        "lastRunDate":{
            "title":"Last Run Date",
            "type":"string",
            "description":"The date the partner contribution request was last processed successfully.",
            "format":"date",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "requestDescription":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"The description of the joint venture partner contribution request.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "stakeholder":{
            "title":"Direct Billed Stakeholder",
            "type":"string",
            "description":"The unique name of the joint venture stakeholder.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "stakeholderId1"
                ]
            },
            "x-queryable":true
        },
        "frequency":{
            "title":"Frequency",
            "type":"string",
            "description":"The frequency of processing partner contribution requests.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "frequencyLookupCode"
                ]
            },
            "x-queryable":true
        },
        "conversionDate":{
            "title":"Conversion Date",
            "type":"string",
            "description":"The date used when retrieving the currency conversion rate for the partner contribution request.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "conversionDateLookupCode"
                ]
            },
            "x-queryable":true
        },
        "jointVenture":{
            "title":"Joint Venture",
            "type":"string",
            "description":"The unique name of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "jointVentureId1"
                ]
            },
            "x-queryable":true
        },
        "weekStartDay":{
            "title":"Start Day",
            "type":"string",
            "description":"The starting day of the week on the partner contribution request that's used when creating weekly partner contributions.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "weekStartDayLookupCode"
                ]
            },
            "x-queryable":true
        },
        "jointVentureDescription":{
            "title":"Joint Venture Description",
            "type":"string",
            "description":"The description of the joint venture.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "contributionRequestDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/jointVentureContributionRequests-contributionRequestDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "contributionsExistFlag":{
            "title":"Partner Contribution Exists",
            "type":"boolean",
            "description":"Indicates whether there are existing partner contributions for the request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "contributionRequestId":{
            "title":"Contribution Request ID",
            "type":"integer",
            "description":"The unique identifier of the partner contribution request.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "lastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the resource item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "structureInstanceNumber":{
            "title":"Structure Instance Number",
            "type":"integer",
            "description":"The chart of accounts instance number associated with the joint venture's business unit.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "FND_ACFF_StructureID":"partnerAccount",
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "sortable":false
            }
        },
        "openDistributionAmountFlag":{
            "title":"Use Open Distribution Amount",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the amounts for the partner contributions are based on the open distribution amounts for the stakeholders.",
            "nullable":false,
            "default":false,
            "x-hints":{
                "fnd:FND_AUDIT_FK_WHEREATTR_ADDL":"LookupType",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.fnd.applcore.lookups.model.publicView.CommonLookupPVO",
                "fnd:FND_AUDIT_VALUE_ADDL":"'YES_NO_NOT_SPECIFIED'",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"Meaning",
                "fnd:FND_AUDIT_FK_WHEREATTR":"LookupCode"
            },
            "x-queryable":true
        },
        "requestedGrossAmount":{
            "title":"Requested Amount",
            "type":"number",
            "description":"The gross amount on the partner contribution request from which partner contributions will be created.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "creationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource item was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ownershipDefinition":{
            "title":"Ownership Definition",
            "maxLength":30,
            "type":"string",
            "description":"The name of the ownership definition.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "createdBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "weekEndDay":{
            "title":"End Day",
            "type":"string",
            "description":"The ending day of the week on the partner contribution request that's used when creating weekly partner contributions.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "weekEndDayLookupCode"
                ]
            },
            "x-queryable":true
        },
        "runDay":{
            "title":"Run Day",
            "type":"string",
            "description":"The run day of the joint venture partner contribution request, for example, the first day of the following week, last day of the current week, first day of the following month, or last day of the current month.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "runDayLookupCode"
                ]
            },
            "x-queryable":true
        },
        "currencyCode":{
            "title":"Currency",
            "maxLength":15,
            "type":"string",
            "description":"The currency code used to create partner contributions from a request.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "startDate":{
            "title":"Start Date",
            "type":"string",
            "description":"The start date of the joint venture partner contribution request.",
            "format":"date",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "status":{
            "title":"Status",
            "type":"string",
            "description":"The status of the joint venture partner contribution request.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"false",
                "dependencies":[
                    "statusLookupCode"
                ]
            },
            "x-queryable":true
        }
    }
}

Nested Schema : contributionRequestDFF

Type: array

Show Source

• Array of: object jointVentureContributionRequests-contributionRequestDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/jointVentureContributionRequests-contributionRequestDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : jointVentureContributionRequests-contributionRequestDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• __FLEX_Context_DisplayValue: string
  Title: Context Segment
• ContributionRequestId: integer (int64)
  Title: Contribution Request ID
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ContributionRequestId":{
            "title":"Contribution Request ID",
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "__FLEX_Context_DisplayValue":{
            "title":"Context Segment",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "updateable":"false",
                "DISPLAYHINT":"Hide",
                "FND_ACFF_IsReadOnly":"true",
                "FND_ACFF_AkaRealSegmentAttrName":"__FLEX_Context",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_ListDisplayAttrName":"Name",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_ValueSetInfo":"_FLEX_ContextValueSet_Internal#INDEPENDENT",
                "controlType":"choice",
                "FND_ACFF_AkaAttrName":"__FLEX_Context_DisplayValue",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_MaximumLength":"1024",
                "FND_ACFF_PreferredDisplayType":"LOV"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

The following example shows how to retrieve all joint venture partner contribution requests by submitting a GET request on the REST resource using cURL.

curl -i -u "username:password" -H "Content-type: application/json" -X GET "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests" 

Example Response Body

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

{
   "items":[
      {
         "contributionRequestId":300100549966528,
         "request":"MONTHLYCONTRIBUTION",
         "requestDescription":"Monthly contribution request",
         "jointVenture":"GLOBALDEVPROJECTJV",
         "jointVentureDescription":"Global enterprise project",
         "startDate":"2022-03-07",
         "endDate":"2022-03-08",
         "openDistributionAmountFlag":false,
         "frequency":"Monthly",
         "requestedGrossAmount":7890,
         "status":"Pending",
         "stakeholder":"GLOBALDEV_BARNCASPER_S4",
         "ownershipDefinition":null,
         "weekStartDay":null,
         "weekEndDay":null,
         "runDay":"Last day of the current month",
         "currencyCode":"USD",
         "conversionDate":null,
         "contributionAccount":"",
         "lastRunDate":null,
         "contributionsExistFlag":false,
         "structureInstanceNumber":46521,
         "createdBy":"username",
         "creationDate":"2022-03-07T08:28:21+00:00",
         "lastUpdatedBy":"username",
         "lastUpdateDate":"2022-03-07T08:28:21.920+00:00",
         "links":[
            {
               "rel":"self",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528",
               "name":"jointVentureContributionRequests",
               "kind":"item",
               "properties":{
                  "changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
               }
            },
            {
               "rel":"canonical",
               "href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureContributionRequests/300100549966528",
               "name":"jointVentureContributionRequests",
               "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/jointVentureContributionRequests",
         "name":"jointVentureContributionRequests",
         "kind":"collection"
      }
   ]
}

Back to Top