Update a joint venture account set
patch
/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}
Request
Path Parameters
-
accountSetId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
accountSet: string
Title:
Account SetMaximum Length:30The unique name of the account set. -
accountSetAssociationsExistFlag: boolean
Title:
Account Set Associations ExistIndicates that this account set is associated with an overhead method. -
accountSetDescription: string
Title:
DescriptionMaximum Length:240The description of the account set. -
accountSetDFF: array
accountSetDFF
-
accountSetLedger: string
Title:
LedgerThe name of the ledger associated with the account set. -
accountSetStatus: string
Title:
StatusThe status of the account set. -
filterSets: array
Filter Sets
Title:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set. -
includePrimarySegmentValuesFlag: boolean
Title:
Include Primary Segment ValuesMaximum Length:1Indicates that primary segment values of the associated joint venture are included in the filter. -
jointVenture: string
Title:
Joint VentureThe name of the joint venture. -
useJointVentureLedgerFlag: boolean
Title:
Use Joint Venture LedgerMaximum Length:1Indicates that the ledger associated with the joint venture will be used for this account set. -
validatePrimarySegmentValuesFlag: boolean
Title:
Validate Primary Segment ValuesMaximum Length:1Indicates that primary segment values used in the filter must be assigned to the joint venture associated with the account set when the option to use the joint venture ledger is selected.
Nested Schema : Filter Sets
Type:
arrayTitle:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set.
Show Source
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : jointVentureAccountSets-filterSets-item-patch-request
Type:
Show Source
object-
filters: array
Filters
Title:
FiltersThe filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management. -
filterSet: string
Title:
Filter SetMaximum Length:30The unique name of the filter set. -
filterSetDescription: string
Title:
DescriptionMaximum Length:240The description of the filter set. -
filterSetDFF: array
filterSetDFF
Nested Schema : Filters
Type:
arrayTitle:
FiltersThe filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filters-item-patch-request
Type:
Show Source
object-
filterDFF: array
filterDFF
-
highValue: string
Title:
High ValueMaximum Length:25The high value of the filter. -
lowValue: string
Title:
Low ValueMaximum Length:25The low value of the filter. -
operator: string
Title:
OperatorThe operator of the filter. -
segment: string
Title:
SegmentThe segment name of the filter.
Nested Schema : jointVentureAccountSets-filterSets-filters-filterDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Nested Schema : jointVentureAccountSets-filterSets-filterSetDFF-item-patch-request
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
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.
Root Schema : jointVentureAccountSets-item-response
Type:
Show Source
object-
accountSet: string
Title:
Account SetMaximum Length:30The unique name of the account set. -
accountSetAssociationsExistFlag: boolean
Title:
Account Set Associations ExistIndicates that this account set is associated with an overhead method. -
accountSetDescription: string
Title:
DescriptionMaximum Length:240The description of the account set. -
accountSetDFF: array
accountSetDFF
-
accountSetId: integer
(int64)
Title:
Account Set IDRead Only:trueThe unique identifier of the account set. -
accountSetLedger: string
Title:
LedgerThe name of the ledger associated with the account set. -
accountSetStatus: string
Title:
StatusThe status of the account set. -
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the account set. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the account set was created. -
filterSets: array
Filter Sets
Title:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set. -
includePrimarySegmentValuesFlag: boolean
Title:
Include Primary Segment ValuesMaximum Length:1Indicates that primary segment values of the associated joint venture are included in the filter. -
jointVenture: string
Title:
Joint VentureThe name of the joint venture. -
jointVentureDescription: string
Title:
Joint Venture DescriptionRead Only:trueThe description of the joint venture. -
jointVentureLedger: string
Title:
Default LedgerRead Only:trueThe name of the default primary ledger associated with the business unit assigned to the joint venture. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the account set was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the account set. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
structureInstanceNumber: integer
Title:
Structure Instance NumberRead Only:trueChart of accounts structure instance number used to associate primary segment values to the joint venture and identify distributable code combinations for GL and subledger accounting transactions. -
useJointVentureLedgerFlag: boolean
Title:
Use Joint Venture LedgerMaximum Length:1Indicates that the ledger associated with the joint venture will be used for this account set. -
validatePrimarySegmentValuesFlag: boolean
Title:
Validate Primary Segment ValuesMaximum Length:1Indicates that primary segment values used in the filter must be assigned to the joint venture associated with the account set when the option to use the joint venture ledger is selected.
Nested Schema : Filter Sets
Type:
arrayTitle:
Filter SetsThe filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-accountSetDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
AccountSetId: integer
(int64)
Title:
Account Set ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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 : jointVentureAccountSets-filterSets-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the filter set. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the filter set was created. -
filters: array
Filters
Title:
FiltersThe filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management. -
filterSet: string
Title:
Filter SetMaximum Length:30The unique name of the filter set. -
filterSetDescription: string
Title:
DescriptionMaximum Length:240The description of the filter set. -
filterSetDFF: array
filterSetDFF
-
filterSetId: integer
(int64)
Title:
Filter Set IDRead Only:trueThe unique identifier of the filter set. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the filter set was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the filter set. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Filters
Type:
arrayTitle:
FiltersThe filters resource is used to view, create, update, or delete filters. These filters are used to identify accounts on financial transactions to be processed by Joint Venture Management.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filters-item-response
Type:
Show Source
object-
createdBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the filter. -
creationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date and time when the filter was created. -
filterDFF: array
filterDFF
-
filterId: integer
(int64)
Title:
Filter IDRead Only:trueThe unique identifier of the filter. -
highValue: string
Title:
High ValueMaximum Length:25The high value of the filter. -
lastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date and time when the filter was last updated. -
lastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the filter. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
lowValue: string
Title:
Low ValueMaximum Length:25The low value of the filter. -
operator: string
Title:
OperatorThe operator of the filter. -
segment: string
Title:
SegmentThe segment name of the filter.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filters-filterDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
AccountFilterId: integer
(int64)
Title:
Filter ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : jointVentureAccountSets-filterSets-filterSetDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
AccountFilterSetId: integer
(int64)
Title:
Filter Set ID -
links: array
Links
Title:
LinksThe link relations associated with the resource instance.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Links
- accountSetDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/accountSetDFFParameters:
- accountSetId:
$request.path.accountSetId
- accountSetId:
- filterSets
-
Operation: /fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/{accountSetId}/child/filterSetsParameters:
- accountSetId:
$request.path.accountSetId
The filter sets resource is used to view, create, update, or delete filter sets that are used to group filters within an account set. - accountSetId:
Examples
The following example shows how to update a joint venture account set by submitting a PATCH request on the REST resource using cURL.
curl -i -u "username:password" -H "Content-type: application/json" -X PATCH -d <payload> "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755"
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"accountSetDescription":"Account set for utility expenses",
"accountSetStatus":"Editing",
"jointVenture":"ALBERTA",
"useJointVentureLedgerFlag":true,
"validatePrimarySegmentValuesFlag":false,
"includePrimarySegmentValuesFlag":false,
"accountSetLedger":null,
"jointVentureLedger":"HEPPLedger US",
"accountSetAssociationsExistFlag":false,
"accountSet":"UTILITYEXPENSE",
"links":[
{
"properties":{
"changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178"
},
"rel":"self",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755",
"name":"jointVentureAccountSets",
"kind":"item"
},
{
"rel":"canonical",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755",
"name":"jointVentureAccountSets",
"kind":"item"
},
{
"rel":"child",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755/child/accountSetDFF",
"name":"accountSetDFF",
"kind":"collection"
},
{
"rel":"child",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755/child/filterSets",
"name":"filterSets",
"kind":"collection"
}
]
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"accountSetId":300100549119755,
"accountSet":"UTILITYEXPENSE",
"accountSetDescription":"Account set for utility expenses",
"accountSetStatus":"Editing",
"jointVenture":"ALBERTA",
"jointVentureDescription":"Alberta North Sea Oil",
"jointVentureLedger":"HEPPLedger US",
"accountSetLedger":null,
"structureInstanceNumber":46521,
"useJointVentureLedgerFlag":true,
"validatePrimarySegmentValuesFlag":false,
"includePrimarySegmentValuesFlag":false,
"accountSetAssociationsExistFlag":false,
"createdBy":"username",
"creationDate":"2021-12-01T10:42:58+00:00",
"lastUpdatedBy":"username",
"lastUpdateDate":"2021-12-02T06:09:07+00:00",
"links":[
{
"rel":"self",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755",
"name":"jointVentureAccountSets",
"kind":"item",
"properties":{
"changeIndicator":"ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel":"canonical",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755",
"name":"jointVentureAccountSets",
"kind":"item"
},
{
"rel":"child",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755/child/accountSetDFF",
"name":"accountSetDFF",
"kind":"collection"
},
{
"rel":"child",
"href":"https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/jointVentureAccountSets/300100549119755/child/filterSets",
"name":"filterSets",
"kind":"collection"
}
]
}