Get a ledger option
get
/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=
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 -
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : fedLedgerOptions-item-response
Type:
Show Source
object
-
AccountAttributeStatus: string
Title:
Account Attribute Status
Read Only:true
Maximum Length:255
Status of the account attribute associated with the ledger option. -
ChartOfAccountsId: integer
(int64)
Title:
Structure Instance Number
The unique identifier of the chart of accounts associated with the ledger option. -
ClosingSegments: string
Title:
Closing Segments
Maximum Length:100
Closing segment of the ledger option. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
DefaultAccountCombination: string
Title:
Default Segments
Default account combination of the ledger option. -
DocumentNumberEntry: string
Title:
Document Number Entry
Document number entry of the ledger option. -
DocumentNumberType: string
Title:
Document Number Type
Document number type of the ledger option. -
FederalGroup: string
Title:
Federal Group Name
Name of the federal group associated with the ledger option. -
fedLedgerOptionBudgetLevels: array
Federal Ledger Option Budget Levels
Title:
Federal Ledger Option Budget Levels
The 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 Date
Read Only:true
The date when the record was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Date when the user last logged in. -
LedgerGroupId: integer
(int64)
Title:
Federal Group ID
Read Only:true
The unique identifier of the ledger group associated with the ledger option. -
LedgerName: string
Title:
Name
Ledger name for the ledger option. -
LevelOptionId: integer
(int64)
Title:
Level Option ID
The unique identifier of the level option associated with the ledger option. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
USSGLTree: string
Title:
USSGL Tree
USSGL tree of the ledger option.
Nested Schema : Federal Ledger Option Budget Levels
Type:
array
Title:
Federal Ledger Option Budget Levels
The ledger option budget levels resource is used to query, create, and update ledger option budget levels.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedLedgerOptions-fedLedgerOptionBudgetLevels-item-response
Type:
Show Source
object
-
BudgetLevelAccount: string
Title:
Budget Level Account
Maximum Length:60
Budget level account of the ledger option budget level. -
BudgetLevelId: integer
(int64)
Title:
Budget Level ID
Read Only:true
The unique identifier of theBudget level associated with the ledger option budget level. -
BudgetLevelName: string
Title:
Budget Level
Read Only:true
Maximum Length:30
Name of the ledger option budget level. -
ControlSpending: string
Title:
Control Spending
Maximum Length:255
Control Spending of the ledger option budget level. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the record was created. -
Description: string
Title:
Description
Read Only:true
Maximum Length:100
Description of the ledger option budget level. -
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:64
The user who last updated the record. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
Date when the user last logged in. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
PriorLevelFunding: string
Title:
Prior Level Funding
Maximum Length:255
Prior level funding of the ledger option budget level. -
SequenceNumber: integer
(int64)
Title:
Budget Level Sequence
Read Only:true
Sequence number of the ledger option budget level.
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 : fedLedgerOptions-fedLedgerOptionDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
LevelOptionId: integer
(int64)
-
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
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 retrieve a ledger option 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/fedLedgerOptions/300100543443163
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "LevelOptionId": 300100543443163, "LedgerName": "US Safety US", "FederalGroup": "Safety Group", "LedgerGroupId": 300100543398854, "ChartOfAccountsId": 63551, "DocumentNumberEntry": "Automatic", "DocumentNumberType": "Numeric", "DefaultAccountCombination": "00-0-0-0-0-21200001-2019-2019-2019-0-0", "USSGLTree": "GL Account US Safety", "ClosingSegments": "Y-Y-Y-Y-Y-Y-Y-Y-Y-Y-Y", "CreatedBy": "FEDERAL", "CreationDate": "2021-07-13T15:53:07.004+00:00", "LastUpdateDate": "2021-07-13T15:53:10.929+00:00", "LastUpdatedBy": "FEDERAL", "LastUpdateLogin": "C5EC80990D48926EE053BB28F70AAA55", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163", "name": "fedLedgerOptions", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163", "name": "fedLedgerOptions", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163/child/fedLedgerOptionBudgetLevels", "name": "fedLedgerOptionBudgetLevels", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedLedgerOptions/300100543443163/child/fedLedgerOptionDFF", "name": "fedLedgerOptionDFF", "kind": "collection" } ] }