Create a federal account attribute
post
/fscmRestApi/resources/11.13.18.05/fedAccountAttributes
Request
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountAttributeHeaderId: integer
(int64)
Title:
Account Attribute Header ID
The unique identifier of the federal account attribute. -
fedAccountAttributeLines: array
Federal Account Attribute Lines
Title:
Federal Account Attribute Lines
The federal account attribute lines enable users to manage account attribute with lines. -
Ledger: string
Title:
Ledger
Maximum Length:255
Name of the ledger associated with the federal account attribute. -
NaturalAccountValue(required): string
Title:
Account
Maximum Length:25
Natural account associated with the federal account attribute. -
Summary: string
Title:
Summary
Maximum Length:255
Type of the natural account associated with the federal account attribute.
Nested Schema : Federal Account Attribute Lines
Type:
array
Title:
Federal Account Attribute Lines
The federal account attribute lines enable users to manage account attribute with lines.
Show Source
Nested Schema : fedAccountAttributes-fedAccountAttributeLines-item-post-request
Type:
Show Source
object
-
AccountAttributeLineId: integer
(int64)
Title:
Account Attribute Line ID
The unique identifier of the federal account attribute line. -
AttributeValue: string
Title:
Value
Maximum Length:255
Value of the federal attribute. -
FederalAttributeName: string
Title:
Federal Attribute Name
Maximum Length:255
Name of the federal attribute associated with the federal account attribute line. -
FromPeriodName: string
Title:
From Period
Maximum Length:15
Name of the starting period associated with the federal account attribute line. -
ToPeriodName: string
Title:
To Period
Maximum Length:15
Name of the ending period associated with the federal account attribute line.
Response
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 : fedAccountAttributes-item-response
Type:
Show Source
object
-
AccountAttributeHeaderId: integer
(int64)
Title:
Account Attribute Header ID
The unique identifier of the federal account attribute. -
AccountDescription: string
Title:
Account Description
Read Only:true
Maximum Length:255
A brief description of the federal account attribute. -
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. -
fedAccountAttributeLines: array
Federal Account Attribute Lines
Title:
Federal Account Attribute Lines
The federal account attribute lines enable users to manage account attribute with lines. -
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
Maximum Length:255
Name of the ledger associated with the federal account attribute. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NaturalAccountValue: string
Title:
Account
Maximum Length:25
Natural account associated with the federal account attribute. -
Summary: string
Title:
Summary
Maximum Length:255
Type of the natural account associated with the federal account attribute.
Nested Schema : Federal Account Attribute Lines
Type:
array
Title:
Federal Account Attribute Lines
The federal account attribute lines enable users to manage account attribute with lines.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedAccountAttributes-fedAccountAttributeLines-item-response
Type:
Show Source
object
-
AccountAttributeLineId: integer
(int64)
Title:
Account Attribute Line ID
The unique identifier of the federal account attribute line. -
AttributeValue: string
Title:
Value
Maximum Length:255
Value of the federal attribute. -
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. -
FederalAttributeName: string
Title:
Federal Attribute Name
Maximum Length:255
Name of the federal attribute associated with the federal account attribute line. -
FromPeriodName: string
Title:
From Period
Maximum Length:15
Name of the starting period associated with the federal account attribute line. -
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. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ToPeriodName: string
Title:
To Period
Maximum Length:15
Name of the ending period associated with the federal account attribute line.
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.
Links
- fedAccountAttributeLines
-
Parameters:
- AccountAttributeHeaderId:
$request.path.AccountAttributeHeaderId
The federal account attribute lines enable users to manage account attribute with lines. - AccountAttributeHeaderId:
Examples
The following example shows how to Create a federal account attribute header by submitting a POST request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/json" -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountAttributes
Request Body Example
The following shows an example of the request body in JSON format.
{ "Ledger": "USFed1", "NaturalAccountValue": "10100002" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "AccountAttributeHeaderId": 300100588710609, "Ledger": "USFed1", "NaturalAccountValue": "10100002", "AccountDescription": "Fund Balance with Treasury", "Summary": "No", "CreatedBy": "username", "CreationDate": "2024-03-09T10:59:06+00:00", "LastUpdateDate": "2024-03-09T10:59:06.113+00:00", "LastUpdatedBy": "username", "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountAttributes/300100588710609", "name": "fedAccountAttributes", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountAttributes/300100588710609", "name": "fedAccountAttributes", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAccountAttributes/300100588710609/child/fedAccountAttributeLines", "name": "fedAccountAttributeLines", "kind": "collection" } ] }