Get all federal USSGL account attributes
get
/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/{AccountId}/child/fedUSSGLAccountAttributes
Request
Path Parameters
-
AccountId(required): integer(int64)
Unique identifier for the U.S. Standard General Ledger account.
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 -
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 USSGL account attribute for the specified primary key.
Finder Variables:- USSGLAccountAttributeId :Unique identifier of the federal USSGL account attributes.
- PrimaryKey :Finds the federal USSGL account attribute for the specified primary key.
-
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:- USSGLAccountAttributeId; integer; Unique identifier of the federal USSGL account attribute.
-
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 : fedUSSGLAccounts-fedUSSGLAccountAttributes
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 : fedUSSGLAccounts-fedUSSGLAccountAttributes-item-response
Type:
Show Source
object
-
Account: string
Title:
Account
Maximum Length:255
The account of the federal USSGL account attribute. -
AccountAttributeValueCodeEight: string
Title:
Account Attribute Value 8
Maximum Length:30
The eighth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeEighteen: string
Title:
Account Attribute Value 18
Maximum Length:30
The 18th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeEleven: string
Title:
Account Attribute Value 11
Maximum Length:30
The 11th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFifteen: string
Title:
Account Attribute Value 15
Maximum Length:30
The 15th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFive: string
Title:
Account Attribute Value 5
Maximum Length:30
The fifth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFour: string
Title:
Account Attribute Value 4
Maximum Length:30
The fourth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeFourteen: string
Title:
Account AttributeValue14
Maximum Length:30
The 14th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeNine: string
Title:
Account Attribute Value 9
Maximum Length:30
The ninth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeNineteen: string
Title:
Account Attribute Value 19
Maximum Length:30
The 19th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeOne: string
Title:
Account Attribute Value 1
Maximum Length:30
The first account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSeven: string
Title:
Account Attribute Value 7
Maximum Length:30
The seventh account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSeventeen: string
Title:
Account Attribute Value 17
Maximum Length:30
The 17th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSix: string
Title:
Account Attribute Value 6
Maximum Length:30
The sixth account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeSixteen: string
Title:
Account Attribute Value16
Maximum Length:30
The 16th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTen: string
Title:
Account Attribute Value 10
Maximum Length:30
The 10th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeThirteen: string
Title:
Account Attribute Value 13
Maximum Length:30
The 13th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeThree: string
Title:
Account Attribute Value 3
Maximum Length:30
The third account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTwelve: string
Title:
Account Attribute Value 12
Maximum Length:30
The 12th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTwenty: string
Title:
Account Attribute Value 20
Maximum Length:30
The 20th account attribute value code of the federal USSGL account attribute. -
AccountAttributeValueCodeTwo: string
Title:
Account Attribute Value 2
Maximum Length:30
The second account attribute value code of the federal USSGL account attribute. -
AttributeName: string
Title:
Attribute Name
Maximum Length:255
Attribute name of the federal USSGL account attribute. -
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. -
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. -
USSGLAccountAttributeId: integer
(int64)
Title:
USSGL Account Attribute ID
Unique identifier of the federal USSGL account attribute.
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 federal USSGL account attributes 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/fedUSSGLAccounts/{id}/child/fedUSSGLAccountAttributes
Response Body Example
The following shows an example of the response body in JSON format.
{ "items": [ { "USSGLAccountAttributeId": 300100579737592, "Account": "101000", "AttributeName": "Begin End Indicator", "AccountAttributeValueCodeOne": "B", "AccountAttributeValueCodeTwo": "E", "AccountAttributeValueCodeThree": null, "AccountAttributeValueCodeFour": null, "AccountAttributeValueCodeFive": null, "AccountAttributeValueCodeSix": null, "AccountAttributeValueCodeSeven": null, "AccountAttributeValueCodeEight": null, "AccountAttributeValueCodeNine": null, "AccountAttributeValueCodeTen": null, "AccountAttributeValueCodeEleven": null, "AccountAttributeValueCodeTwelve": null, "AccountAttributeValueCodeThirteen": null, "AccountAttributeValueCodeFourteen": null, "AccountAttributeValueCodeFifteen": null, "AccountAttributeValueCodeSixteen": null, "AccountAttributeValueCodeSeventeen": null, "AccountAttributeValueCodeEighteen": null, "AccountAttributeValueCodeNineteen": null, "AccountAttributeValueCodeTwenty": null, "CreatedBy": "username", "CreationDate": "2023-09-01T00:44:20+00:00", "LastUpdateDate": "2023-09-01T00:44:25.951+00:00", "LastUpdatedBy": "username", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737592", "name": "fedUSSGLAccountAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737592", "name": "fedUSSGLAccountAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145", "name": "fedUSSGLAccounts", "kind": "item" } ] }, { "USSGLAccountAttributeId": 300100579737593, "Account": "101000", "AttributeName": "Debit Credit Indicator", "AccountAttributeValueCodeOne": "D", "AccountAttributeValueCodeTwo": null, "AccountAttributeValueCodeThree": null, "AccountAttributeValueCodeFour": null, "AccountAttributeValueCodeFive": null, "AccountAttributeValueCodeSix": null, "AccountAttributeValueCodeSeven": null, "AccountAttributeValueCodeEight": null, "AccountAttributeValueCodeNine": null, "AccountAttributeValueCodeTen": null, "AccountAttributeValueCodeEleven": null, "AccountAttributeValueCodeTwelve": null, "AccountAttributeValueCodeThirteen": null, "AccountAttributeValueCodeFourteen": null, "AccountAttributeValueCodeFifteen": null, "AccountAttributeValueCodeSixteen": null, "AccountAttributeValueCodeSeventeen": null, "AccountAttributeValueCodeEighteen": null, "AccountAttributeValueCodeNineteen": null, "AccountAttributeValueCodeTwenty": null, "CreatedBy": "username", "CreationDate": "2023-09-01T00:44:25.766+00:00", "LastUpdateDate": "2023-09-01T00:44:25.976+00:00", "LastUpdatedBy": "username", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737593", "name": "fedUSSGLAccountAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737593", "name": "fedUSSGLAccountAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145", "name": "fedUSSGLAccounts", "kind": "item" } ] }, { "USSGLAccountAttributeId": 300100579737594, "Account": "101000", "AttributeName": "Federal Non-Federal Code", "AccountAttributeValueCodeOne": "G", "AccountAttributeValueCodeTwo": null, "AccountAttributeValueCodeThree": null, "AccountAttributeValueCodeFour": null, "AccountAttributeValueCodeFive": null, "AccountAttributeValueCodeSix": null, "AccountAttributeValueCodeSeven": null, "AccountAttributeValueCodeEight": null, "AccountAttributeValueCodeNine": null, "AccountAttributeValueCodeTen": null, "AccountAttributeValueCodeEleven": null, "AccountAttributeValueCodeTwelve": null, "AccountAttributeValueCodeThirteen": null, "AccountAttributeValueCodeFourteen": null, "AccountAttributeValueCodeFifteen": null, "AccountAttributeValueCodeSixteen": null, "AccountAttributeValueCodeSeventeen": null, "AccountAttributeValueCodeEighteen": null, "AccountAttributeValueCodeNineteen": null, "AccountAttributeValueCodeTwenty": null, "CreatedBy": "username", "CreationDate": "2023-09-01T00:44:25.817+00:00", "LastUpdateDate": "2023-09-01T00:44:25.983+00:00", "LastUpdatedBy": "username", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737594", "name": "fedUSSGLAccountAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737594", "name": "fedUSSGLAccountAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145", "name": "fedUSSGLAccounts", "kind": "item" } ] }, { "USSGLAccountAttributeId": 300100579737595, "Account": "101000", "AttributeName": "Trading Partner Agency Identifier", "AccountAttributeValueCodeOne": "###", "AccountAttributeValueCodeTwo": null, "AccountAttributeValueCodeThree": null, "AccountAttributeValueCodeFour": null, "AccountAttributeValueCodeFive": null, "AccountAttributeValueCodeSix": null, "AccountAttributeValueCodeSeven": null, "AccountAttributeValueCodeEight": null, "AccountAttributeValueCodeNine": null, "AccountAttributeValueCodeTen": null, "AccountAttributeValueCodeEleven": null, "AccountAttributeValueCodeTwelve": null, "AccountAttributeValueCodeThirteen": null, "AccountAttributeValueCodeFourteen": null, "AccountAttributeValueCodeFifteen": null, "AccountAttributeValueCodeSixteen": null, "AccountAttributeValueCodeSeventeen": null, "AccountAttributeValueCodeEighteen": null, "AccountAttributeValueCodeNineteen": null, "AccountAttributeValueCodeTwenty": null, "CreatedBy": "username", "CreationDate": "2023-09-01T00:44:25.860+00:00", "LastUpdateDate": "2023-09-01T00:44:25.989+00:00", "LastUpdatedBy": "username", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737595", "name": "fedUSSGLAccountAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737595", "name": "fedUSSGLAccountAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145", "name": "fedUSSGLAccounts", "kind": "item" } ] }, { "USSGLAccountAttributeId": 300100579737596, "Account": "101000", "AttributeName": "Trading Partner Main Account Identifier", "AccountAttributeValueCodeOne": "####", "AccountAttributeValueCodeTwo": null, "AccountAttributeValueCodeThree": null, "AccountAttributeValueCodeFour": null, "AccountAttributeValueCodeFive": null, "AccountAttributeValueCodeSix": null, "AccountAttributeValueCodeSeven": null, "AccountAttributeValueCodeEight": null, "AccountAttributeValueCodeNine": null, "AccountAttributeValueCodeTen": null, "AccountAttributeValueCodeEleven": null, "AccountAttributeValueCodeTwelve": null, "AccountAttributeValueCodeThirteen": null, "AccountAttributeValueCodeFourteen": null, "AccountAttributeValueCodeFifteen": null, "AccountAttributeValueCodeSixteen": null, "AccountAttributeValueCodeSeventeen": null, "AccountAttributeValueCodeEighteen": null, "AccountAttributeValueCodeNineteen": null, "AccountAttributeValueCodeTwenty": null, "CreatedBy": "username", "CreationDate": "2023-09-01T00:44:25.895+00:00", "LastUpdateDate": "2023-09-01T00:44:25.992+00:00", "LastUpdatedBy": "username", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737596", "name": "fedUSSGLAccountAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes/300100579737596", "name": "fedUSSGLAccountAttributes", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145", "name": "fedUSSGLAccounts", "kind": "item" } ] } ], "count": 5, "hasMore": false, "limit": 25, "offset": 0, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedUSSGLAccounts/300000000189145/child/fedUSSGLAccountAttributes", "name": "fedUSSGLAccountAttributes", "kind": "collection" } ] }