Update a ledger option
patch
/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}
Request
Path Parameters
-
LevelOptionId(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-
ChartOfAccountsId: integer
(int64)
Title:
Structure Instance NumberThe unique identifier of the chart of accounts associated with the ledger option. -
DocumentNumberEntry: string
Title:
Document Number EntryDocument number entry of the ledger option. -
DocumentNumberType: string
Title:
Document Number TypeDocument number type of the ledger option. -
FederalGroup: string
Title:
Federal Group NameName of the federal group associated with the ledger option. -
fedLedgerOptionBudgetLevels: array
Federal Ledger Option Budget Levels
Title:
Federal Ledger Option Budget LevelsThe ledger option budget levels resource is used to query, create, and update ledger option budget levels. -
fedLedgerOptionDFF: array
fedLedgerOptionDFF
-
LedgerName: string
Title:
NameLedger name for the ledger option. -
USSGLTree: string
Title:
USSGL TreeUSSGL tree of the ledger option.
Nested Schema : Federal Ledger Option Budget Levels
Type:
arrayTitle:
Federal Ledger Option Budget LevelsThe ledger option budget levels resource is used to query, create, and update ledger option budget levels.
Show Source
Nested Schema : fedLedgerOptions-fedLedgerOptionBudgetLevels-item-patch-request
Type:
Show Source
object-
BudgetLevelAccount: string
Title:
Budget Level AccountMaximum Length:60Budget level account of the ledger option budget level. -
ControlSpending: string
Title:
Control SpendingMaximum Length:255Control Spending of the ledger option budget level. -
PriorLevelFunding: string
Title:
Prior Level FundingMaximum Length:255Prior level funding of the ledger option budget level.
Nested Schema : schema
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
LevelOptionId: integer
(int64)
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 : fedLedgerOptions-item-response
Type:
Show Source
object-
AccountAttributeStatus: string
Title:
Account Attribute StatusRead Only:trueMaximum Length:255Status of the account attribute associated with the ledger option. -
ChartOfAccountsId: integer
(int64)
Title:
Structure Instance NumberThe unique identifier of the chart of accounts associated with the ledger option. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
DocumentNumberEntry: string
Title:
Document Number EntryDocument number entry of the ledger option. -
DocumentNumberType: string
Title:
Document Number TypeDocument number type of the ledger option. -
FederalGroup: string
Title:
Federal Group NameName of the federal group associated with the ledger option. -
fedLedgerOptionBudgetLevels: array
Federal Ledger Option Budget Levels
Title:
Federal Ledger Option Budget LevelsThe ledger option budget levels resource is used to query, create, and update ledger option budget levels. -
fedLedgerOptionDFF: array
fedLedgerOptionDFF
-
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32Date when the user last logged in. -
LedgerGroupId: integer
(int64)
Title:
Federal Group IDRead Only:trueThe unique identifier of the ledger group associated with the ledger option. -
LedgerName: string
Title:
NameLedger name for the ledger option. -
LevelOptionId: integer
(int64)
Title:
Level Option IDThe unique identifier of the level option associated with the ledger option. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
USSGLTree: string
Title:
USSGL TreeUSSGL tree of the ledger option.
Nested Schema : Federal Ledger Option Budget Levels
Type:
arrayTitle:
Federal Ledger Option Budget LevelsThe ledger option budget levels resource is used to query, create, and update ledger option budget levels.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : fedLedgerOptions-fedLedgerOptionBudgetLevels-item-response
Type:
Show Source
object-
BudgetLevelAccount: string
Title:
Budget Level AccountMaximum Length:60Budget level account of the ledger option budget level. -
BudgetLevelId: integer
(int64)
Title:
Budget Level IDRead Only:trueThe unique identifier of theBudget level associated with the ledger option budget level. -
BudgetLevelName: string
Title:
Budget LevelRead Only:trueMaximum Length:30Name of the ledger option budget level. -
ControlSpending: string
Title:
Control SpendingMaximum Length:255Control Spending of the ledger option budget level. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the record was created. -
Description: string
Title:
DescriptionRead Only:trueMaximum Length:100Description of the ledger option budget level. -
LastUpdateDate: string
(date-time)
Title:
Last Update DateRead Only:trueThe date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update LoginRead Only:trueMaximum Length:32Date when the user last logged in. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
PriorLevelFunding: string
Title:
Prior Level FundingMaximum Length:255Prior level funding of the ledger option budget level. -
SequenceNumber: integer
(int64)
Title:
Budget Level SequenceRead Only:trueSequence number of the ledger option budget level.
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 : fedLedgerOptions-fedLedgerOptionDFF-item-response
Type:
Show Source
object-
__FLEX_Context: string
Title:
Context SegmentMaximum Length:150 -
__FLEX_Context_DisplayValue: string
Title:
Context Segment -
LevelOptionId: integer
(int64)
-
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
- fedLedgerOptionBudgetLevels
-
Parameters:
- LevelOptionId:
$request.path.LevelOptionId
The ledger option budget levels resource is used to query, create, and update ledger option budget levels. - LevelOptionId:
- fedLedgerOptionDFF
-
Operation: /fscmRestApi/resources/11.13.18.05/fedLedgerOptions/{LevelOptionId}/child/fedLedgerOptionDFFParameters:
- LevelOptionId:
$request.path.LevelOptionId
- LevelOptionId:
Examples
The following example shows how to update a ledger option by submitting a PATCH request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X PATCH -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100542886804
Example Request Body
The following example shows the contents of the request body in JSON format:
{
"DocumentNumberEntry": "Manual"
}
Example Response Body
The following example shows the contents of the response body in JSON format:
{
"LevelOptionId": 300100542886804,
"LedgerName": "Vision Operations (USA)",
"FederalGroup": "Defense",
"LedgerGroupId": 300100542886799,
"ChartOfAccountsId": 101,
"DocumentNumberEntry": "Manual",
"DocumentNumberType": "Numeric",
"DefaultAccountCombination": "01-000-1110-0000-000",
"USSGLTree": "All Accounts",
"ClosingSegments": "Y-Y-Y-Y-N",
"CreatedBy": "FEDERAL",
"CreationDate": "2021-07-06T18:02:11.004+00:00",
"LastUpdateDate": "2021-07-13T16:02:21+00:00",
"LastUpdatedBy": "FEDERAL",
"LastUpdateLogin": "C5EC840F2AED9276E053BB28F70A4D70",
"links": [
{
"rel": "self",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100542886804",
"name": "fedLedgerOptions",
"kind": "item",
"properties": {
"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000378"
}
},
{
"rel": "canonical",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100542886804",
"name": "fedLedgerOptions",
"kind": "item"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100542886804/child/fedLedgerOptionBudgetLevels",
"name": "fedLedgerOptionBudgetLevels",
"kind": "collection"
},
{
"rel": "child",
"href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100542886804/child/fedLedgerOptionDFF",
"name": "fedLedgerOptionDFF",
"kind": "collection"
}
]
}