Get all fund attributes
get
/fscmRestApi/resources/11.13.18.05/fedFundAttributes
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 fund attribute that matches the primary key specified.
Finder Variables- FundValueId; integer; Unique identifier for the fund attribute.
- PrimaryKey Finds the fund attribute that matches the primary key 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:- ApportionmentCategory; string; Apportionment category of the fund attribute.
- AuthorityDuration; string; Authority duration code of the treasury account symbol.
- BorrowingSource; string; Borrowing source of the fund attribute.
- BudgetEnforcementAct; string; Budget enforcement code of the fund attribute.
- BudgetSubfunction; string; Budget subfunction code of the fund attribute.
- CopyFund; string; Indicates whether the fund information of the fund attribute will be copied to the next year.
- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- CustodialOrNonCustodial; string; Custodial or noncustodial code of the fund attribute.
- DefaultCollectionBetcCode; string; Default collection BETC code of the fund attribute.
- DefaultCollectionBetcName; string; Default collection BETC name of the fund attribute.
- DefaultPaymentBetcCode; string; Default payment BETC code of the fund attribute.
- DefaultPaymentBetcName; string; Default payment BETC name of the fund attribute.
- DefiniteOrIndefiniteAuthority; string; Definite or indefinite authority of the fund attribute.
- DirectOrReimbursable; string; Direct or reimbursable code of the fund attribute.
- FedAccountSymbolTitle; string; Federal account symbol title of the fund attribute.
- FundCode; string; Fund code of the fund attribute.
- FundStructureInstanceId; integer; Fund structure instance identifier of the fund attribute.
- FundValueId; integer; Unique identifier for the fund attribute.
- FundingDerivationType; string; Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- Ledger; string; Ledger of the fund attribute.
- LedgerId; integer; The unique identifier of the federal ledger.
- NextYearFund; string; Next year fund value of the fund attribute.
- OutlaysBeaCategory; string; Outlays BEA category of the fund attribute.
- RequisitionClosingMethod; string; Requisition closing method of the fund attribute.
- TreasuryAccountSymbol; string; Treasury account symbol of the fund attribute.
- TreasuryAccountSymbolId; integer; Unique identifier of the treasury account symbol.
- YearOfBudgetAuthority; string; Identifies the year of budget authority indicator associated with the account.
-
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 : fedFundAttributes
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 : fedFundAttributes-item-response
Type:
Show Source
object
-
ApportionmentCategory: string
Title:
Apportionment Category Code
Apportionment category of the fund attribute. -
AuthorityDuration: string
Title:
Authority Duration
Maximum Length:1
Authority duration code of the treasury account symbol. -
BorrowingSource: string
Title:
Borrowing Source Code
Borrowing source of the fund attribute. -
BudgetEnforcementAct: string
Title:
Budget Enforcement Act Category Code
Default Value:Discretionary
Budget enforcement code of the fund attribute. -
BudgetSubfunction: string
Title:
Budget Subfunction Code
Budget subfunction code of the fund attribute. -
CopyFund: string
Title:
Copy fund attributes to next year
Indicates whether the fund information of the fund attribute will be copied to the next year. -
CreatedBy: string
Read Only:
true
Maximum Length:64
The user who created the record. -
CreationDate: string
(date-time)
Read Only:
true
The date when the record was created. -
CustodialOrNonCustodial: string
Title:
Custodial or Noncustodial Code
Default Value:Non-Custodial
Custodial or noncustodial code of the fund attribute. -
DefaultCollectionBetcCode: string
Title:
Default Collection BETC
Maximum Length:8
Default collection BETC code of the fund attribute. -
DefaultCollectionBetcName: string
Title:
Default Collection BETC Name
Read Only:true
Default collection BETC name of the fund attribute. -
DefaultPaymentBetcCode: string
Title:
Default Payment BETC
Maximum Length:8
Default payment BETC code of the fund attribute. -
DefaultPaymentBetcName: string
Title:
Default Payment BETC Name
Read Only:true
Default payment BETC name of the fund attribute. -
DefiniteOrIndefiniteAuthority: string
Title:
Definite or Indefinite Authority
Default Value:Definite
Definite or indefinite authority of the fund attribute. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable Code
Direct or reimbursable code of the fund attribute. -
FedAccountSymbolTitle: string
Title:
Federal Account Symbol
Federal account symbol title of the fund attribute. -
fedFundAttributeDFF: array
fedFundAttributeDFF
-
FundCode: string
Title:
Fund
Maximum Length:25
Fund code of the fund attribute. -
FundingDerivationType: string
Title:
Funding Derivation Type
Type of funding derivation associated with the adjustment business event type codes list of values. The valid values are Derived from General Fund, Not Derived from General Fund. -
FundStructureInstanceId: integer
(int64)
Title:
Fund Structure Instance ID
Fund structure instance identifier of the fund attribute. -
FundValueId: integer
(int64)
Title:
Fund Value ID
Unique identifier for the fund attribute. -
LastUpdateDate: string
(date-time)
Read Only:
true
The date when the record was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
The user who last updated the record. -
Ledger: string
Title:
Ledger
Ledger of the fund attribute. -
LedgerId: integer
(int64)
Title:
Ledger
The unique identifier of the federal ledger. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NextYearFund: string
Title:
Next Year Fund
Maximum Length:25
Next year fund value of the fund attribute. -
OutlaysBeaCategory: string
Title:
Outlays BEA Category Code
Default Value:Discretionary
Outlays BEA category of the fund attribute. -
RequisitionClosingMethod: string
Title:
Requisition Closing Method
Requisition closing method of the fund attribute. -
TreasuryAccountSymbol: string
Title:
Treasury Account Symbol
Treasury account symbol of the fund attribute. -
TreasuryAccountSymbolId: integer
(int64)
Title:
Treasury Account Symbol ID
Unique identifier of the treasury account symbol. -
YearOfBudgetAuthority: string
Title:
Year of Budget Authority Indicator
Maximum Length:255
Identifies the year of budget authority indicator associated with the account.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedFundAttributes-fedFundAttributeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:150
-
__FLEX_Context_DisplayValue: string
Title:
Context Segment
-
FundValueId: 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
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.
Examples
The following example shows how to retrieve all the fund attributes 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/fedFundAttributes
Example Response Body
The following example shows the contents of the response body in JSON format:
{ "items": [ { "FundValueId": 300100211882265, "Ledger": "USFed1 US", "LedgerId": 300100125495724, "FundStructureInstanceId": 17520, "TreasuryAccountSymbol": "06918/210718", "AuthorityDuration": "M", "TreasuryAccountSymbolId": 300100211711868, "FundCode": "H075160118DB", "FedAccountSymbolTitle": "Capital Assistance for Passenger Service", "ApportionmentCategory": "Quarterly Apportionment", "DirectOrReimbursable": "Direct", "BudgetEnforcementAct": "Discretionary", "OutlaysBeaCategory": "Discretionary", "CustodialOrNonCustodial": "Non-Custodial", "DefiniteOrIndefiniteAuthority": "Definite", "BorrowingSource": null, "BudgetSubfunction": null, "CopyFund": "No", "NextYearFund": null, "RequisitionClosingMethod": "Closing", "CreatedBy": "FEDERAL", "CreationDate": "2020-12-10T12:11:36.002+00:00", "LastUpdatedBy": "FEDERAL", "LastUpdateDate": "2020-12-10T12:11:37.363+00:00", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265", "name": "fedFundAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265", "name": "fedFundAttributes", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes/300100211882265/child/fedFundAttributeDFF", "name": "fedFundAttributeDFF", "kind": "collection" } ] }, ... ], "count": 25, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedFundAttributes", "name": "fedFundAttributes", "kind": "collection" } ] }