Get all federal attribute supplemental rules
get
/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules
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 attribute supplemental rule that matches the specified primary key criteria.
Finder Variables- SupplRuleHeaderId; integer; The unique identifier of the federal attribute supplemental rule.
- PrimaryKey Finds the federal attribute supplemental rule that matches the specified primary key criteria.
-
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:- CreatedBy; string; The user who created the record.
- CreationDate; string; The date when the record was created.
- FederalAttributeName; string; Name of the attribute associated with the federal attribute supplemental rule.
- LastUpdateDate; string; The date when the record was last updated.
- LastUpdatedBy; string; The user who last updated the record.
- LedgerName; string; Name of the ledger associated with the federal attribute supplemental rule
- SupplRuleHeaderId; integer; The unique identifier of the federal attribute supplemental rule.
- TreasuryAccountSymbol; string; Treasury account symbol associated with the federal attribute supplemental rule
-
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 : fedAttributeSupplementalRules
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 : fedAttributeSupplementalRules-item-response
Type:
Show Source
object
-
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. -
fedAttributeSupplementalRuleLines: array
Federal Attribute Supplemental Rule Lines
Title:
Federal Attribute Supplemental Rule Lines
The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines. -
FederalAttributeName: string
Title:
Federal Attribute Name
Maximum Length:150
Name of the attribute associated with the federal attribute supplemental rule. -
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. -
LedgerName: string
Title:
Ledger Name
Maximum Length:30
Name of the ledger associated with the federal attribute supplemental rule -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SupplRuleHeaderId: integer
(int64)
Title:
Supplemental Rule Header ID
The unique identifier of the federal attribute supplemental rule. -
TreasuryAccountSymbol: string
Title:
Treasury Account Symbol
Maximum Length:255
Treasury account symbol associated with the federal attribute supplemental rule
Nested Schema : Federal Attribute Supplemental Rule Lines
Type:
array
Title:
Federal Attribute Supplemental Rule Lines
The federal attribute supplemental rule lines enable users to manage attribute supplemental rule with lines.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-item-response
Type:
Show Source
object
-
Allocate: string
Title:
Allocate
Maximum Length:255
Allocation configures derivation for federal attribute supplemental rules including allocation of amount by percentage to the reporting codes. -
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:255
A brief description of the reporting code associated with the federal supplemental rule line. -
fedAttributeSupplementalRuleAllocations: array
Federal Attribute Supplemental Rule Allocations
Title:
Federal Attribute Supplemental Rule Allocations
The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations. -
fedAttributeSupplementalRuleExceptionMessages: array
Federal Attribute Supplemental Rule Exception Messages
Title:
Federal Attribute Supplemental Rule Exception Messages
The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages. -
fedAttributeSupplementalRuleFilters: array
Federal Attribute Supplemental Rule Line Filters
Title:
Federal Attribute Supplemental Rule Line Filters
The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters. -
FromPeriod: string
Title:
From Period
Maximum Length:15
Name of the starting period associated with the federal supplemental rule line. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ReportingCodeValue: string
Title:
Reporting Code
Maximum Length:255
Reporting code value of the federal attribute supplemental rule line. -
SupplRuleLineId: integer
(int64)
Title:
Supplemental Rule Line ID
The unique identifier of the federal attribute supplemental rule line. -
ToPeriod: string
Title:
To Period
Maximum Length:15
Name of the ending period associated with the federal account attribute line. -
ValidationStatus: string
Title:
Validation Status
Maximum Length:255
Validation status of the federal attribute supplemental rule line.
Nested Schema : Federal Attribute Supplemental Rule Allocations
Type:
array
Title:
Federal Attribute Supplemental Rule Allocations
The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations.
Show Source
Nested Schema : Federal Attribute Supplemental Rule Exception Messages
Type:
array
Title:
Federal Attribute Supplemental Rule Exception Messages
The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages.
Show Source
Nested Schema : Federal Attribute Supplemental Rule Line Filters
Type:
array
Title:
Federal Attribute Supplemental Rule Line Filters
The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleAllocations-item-response
Type:
Show Source
object
-
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:255
Description of the federal attribute supplemental rule allocation. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Percentage: number
Title:
Percentage
Percentage associated with the federal attribute supplemental rule allocation. -
ReportingCodeValue: string
Title:
Reporting Code
Maximum Length:255
Value associated with the federal attribute supplemental rule allocation. -
SupplRuleAllocationId: integer
(int64)
Title:
Supplemental Rule Allocation ID
The unique identifier of the federal attribute supplemental rule allocation.
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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleExceptionMessages-item-response
Type:
Show Source
object
-
Code: string
Title:
Exception Code
Maximum Length:30
Code of the federal attribute supplemental rule exception message. -
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:
Exception Text
Maximum Length:4000
Description of the federal attribute supplemental rule exception message. -
ExceptionUniqueId: integer
(int64)
Title:
Exception Unique Id
The unique identifier of the federal attribute supplemental rule exception message. -
JobId: integer
(int64)
Title:
Job Id
The unique identifier of the job associated with the federal attribute supplemental rule exception message. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentTableUniqueId: integer
Title:
Parent Table Unique Id
The unique identifier of the parent table associated with the federal attribute supplemental rule exception message. -
ProcessName: string
Title:
Process Name
Maximum Length:150
Name of the process associated with the federal attribute supplemental rule exception message.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-response
Type:
Show Source
object
-
AccountingSegment: string
Title:
Accounting Segment
Maximum Length:255
Accounting segment of the federal attribute supplemental rule filter. -
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. -
HighValue: string
Title:
High Value
Maximum Length:25
High Value of the filter range of the federal attribute supplemental rule filter. The high value should be greater than or equal to the low value. -
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 date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
LowValue: string
Title:
Low Value
Maximum Length:25
Low value of the filter range of the federal attribute supplemental rule filter. The low value should be less than or equal to the high value. -
Operator: string
Title:
Operator
Maximum Length:255
Operator of the federal attribute supplemental rule filter. -
SupplRuleFilterId: integer
(int64)
Title:
Supplemental Rule Filter ID
The unique identifier of the federal attribute supplemental rule filter. -
Value: string
Title:
Value
Maximum Length:25
Value of the federal attribute supplemental rule filter. This attribute is enabled when the operator is Equal To or Not Equal To.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- validateLines
-
Performs validation for the lines of a federal attribute supplemental rule.
Examples
The following example shows how to retrieve all federal attribute supplemental rules by submitting a GET request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X GET -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "SupplRuleHeaderId": 300100583960345, "LedgerName": "GTAS1 US", "FederalAttributeName": "Disaster Emergency Fund Code", "TreasuryAccountSymbol": "GTAS001", "CreationDate": "2024-01-23T12:50:33+00:00", "CreatedBy": "username", "LastUpdatedBy": "username", "LastUpdateDate": "2024-01-23T12:50:33.272+00:00", "links": [ { "rel": "self", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100583960345", "name": "fedAttributeSupplementalRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100583960345", "name": "fedAttributeSupplementalRules", "kind": "item" }, { "rel": "child", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100583960345/child/fedAttributeSupplementalRuleLines", "name": "fedAttributeSupplementalRuleLines", "kind": "collection" } ] }, { "SupplRuleHeaderId": 300100588674432, "LedgerName": "USFed1 US", "FederalAttributeName": "Apportionment Category Code", "TreasuryAccountSymbol": "All", "CreationDate": "2024-03-11T11:29:01+00:00", "CreatedBy": "username", "LastUpdatedBy": "username", "LastUpdateDate": "2024-03-11T11:29:01.078+00:00", "links": [ { "rel": "self", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432", "name": "fedAttributeSupplementalRules", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432", "name": "fedAttributeSupplementalRules", "kind": "item" }, { "rel": "child", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432/child/fedAttributeSupplementalRuleLines", "name": "fedAttributeSupplementalRuleLines", "kind": "collection" } ] } ], "count": 2, "hasMore": true, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules", "name": "fedAttributeSupplementalRules", "kind": "collection" }, { "rel": "action", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/action/validateLines", "name": "validateLines", "kind": "other" } ] }}