Get all federal fund attributes
get
/fscmRestApi/resources/11.13.18.05/fedFundAttributesLOV
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 federal fund attribute that matches the primary key criteria specified.
Finder Variables- FundValueId; integer; The unique identifier of the federal fund value.
- PrimaryKey Finds the federal fund attribute that matches the primary key criteria 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:- AgencyIdentifier; string; Agency identifier of the federal fund attributes list of values.
- ApportionmentCategory; string; Apportionment category code of the federal fund attributes list of values.
- AuthorityDurationCode; string; Authority duration code of the federal fund attributes list of values.
- BorrowingSource; string; Borrowing source of the federal fund attributes list of values.
- BudgetEnforcementAct; string; Budget enforcement act of the federal fund attributes list of values.
- BudgetSubfunction; string; Budget subfunction of the federal fund attributes list of values.
- CustodialOrNonCustodial; string; Custodial or noncustodial of the federal fund attributes list of values.
- DefiniteOrIndefiniteAuthority; string; Definite or indefinite authority of the federal fund attributes list of values.
- DirectOrReimbursable; string; Direct or reimbursable code of the federal fund attributes list of values.
- FederalAccountSymbolTitle; string; Federal account symbol title of the federal fund attributes list of values.
- FundCode; string; Fund code of the federal fund attributes list of values.
- FundValueId; integer; Unique identifier of the federal fund value of the federal fund attributes list of values.
- Ledger; string; Ledger of the federal fund attributes list of values.
- LedgerId; integer; Unique identifier of the ledger of the federal fund attributes list of values.
- MainAccountCode; string; Main account code of the federal fund attributes list of values.
- OutlaysBeaCategory; string; Outlays BEA category of the federal fund attributes list of values.
- TreasuryAccountSymbol; string; Treasury account symbol of the federal fund attributes list of values.
- TreasuryAccountSymbolId; integer; Unique identifier of the treasury account symbol of the federal fund attributes list of values.
- YearOfBudgetAuthority; string; Identifies the year of budget authority indicator associated with the account list of values.
-
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 : fedFundAttributesLOV
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 : fedFundAttributesLOV-item-response
Type:
Show Source
object
-
AgencyIdentifier: string
Title:
Agency Identifier
Read Only:true
Maximum Length:255
Agency identifier of the federal fund attributes list of values. -
ApportionmentCategory: string
Title:
Apportionment Category Code
Read Only:true
Maximum Length:255
Apportionment category code of the federal fund attributes list of values. -
AuthorityDurationCode: string
Title:
Authority Duration Code
Read Only:true
Maximum Length:30
Authority duration code of the federal fund attributes list of values. -
BorrowingSource: string
Title:
Borrowing Source Code
Read Only:true
Maximum Length:255
Borrowing source of the federal fund attributes list of values. -
BudgetEnforcementAct: string
Title:
Budget Enforcement Act Category Code
Read Only:true
Maximum Length:255
Budget enforcement act of the federal fund attributes list of values. -
BudgetSubfunction: string
Title:
Budget Subfunction Code
Read Only:true
Maximum Length:255
Budget subfunction of the federal fund attributes list of values. -
CustodialOrNonCustodial: string
Title:
Custodial or Noncustodial Code
Read Only:true
Maximum Length:255
Custodial or noncustodial of the federal fund attributes list of values. -
DefiniteOrIndefiniteAuthority: string
Title:
Definite or Indefinite Authority
Read Only:true
Maximum Length:255
Definite or indefinite authority of the federal fund attributes list of values. -
DirectOrReimbursable: string
Title:
Direct or Reimbursable Code
Read Only:true
Maximum Length:255
Direct or reimbursable code of the federal fund attributes list of values. -
FederalAccountSymbolTitle: string
Title:
Federal Account Symbol Title
Read Only:true
Maximum Length:255
Federal account symbol title of the federal fund attributes list of values. -
FundCode: string
Title:
Fund
Read Only:true
Maximum Length:25
Fund code of the federal fund attributes list of values. -
FundValueId: integer
(int64)
Title:
Fund Value ID
Read Only:true
Unique identifier of the federal fund value of the federal fund attributes list of values. -
Ledger: string
Title:
Ledger
Read Only:true
Maximum Length:255
Ledger of the federal fund attributes list of values. -
LedgerId: integer
(int64)
Title:
Ledger ID
Read Only:true
Unique identifier of the ledger of the federal fund attributes list of values. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MainAccountCode: string
Title:
Main Account Code
Read Only:true
Maximum Length:255
Main account code of the federal fund attributes list of values. -
OutlaysBeaCategory: string
Title:
Outlays BEA Category Code
Read Only:true
Maximum Length:255
Outlays BEA category of the federal fund attributes list of values. -
TreasuryAccountSymbol: string
Title:
Treasury Account Symbol
Read Only:true
Maximum Length:35
Treasury account symbol of the federal fund attributes list of values. -
TreasuryAccountSymbolId: integer
(int64)
Title:
Treasury Account Symbol ID
Read Only:true
Unique identifier of the treasury account symbol of the federal fund attributes list of values. -
YearOfBudgetAuthority: string
Title:
Year of Budget Authority
Read Only:true
Maximum Length:255
Identifies the year of budget authority indicator associated with the account list of values.
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.