Create a federal DATA Act balance
post
/fscmRestApi/resources/11.13.18.05/fedDATAActBalances
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
-
BalanceHeaderId: integer
(int64)
Title:
Balance Header ID
The unique identifier of the federal DATA Act balance. -
fedDATAActBalanceCalculationTotals: array
Federal DATA Act Balance Calculation Totals
Title:
Federal DATA Act Balance Calculation Totals
The federal DATA Act balance calculations totals enables users to manage DATA Act balance calculation with type total. -
fedDATAActBalanceCalculationUSSGLAccounts: array
Federal DATA Act Balance Calculation USSGL Accounts
Title:
Federal DATA Act Balance Calculation USSGL Accounts
The federal DATA Act balance calculation USSGL accounts enables users to manage USSGL accounts with type balance. -
FileA: string
Title:
File A
Maximum Length:255
File A of the federal DATA Act balance. -
FileB: string
Title:
File B
Maximum Length:255
File B of the federal DATA Act balance. -
FileC: string
Title:
File C
Maximum Length:255
File C of the federal DATA Act balance. -
Name(required): string
Title:
Name
Maximum Length:120
Name of the federal DATA Act balance. -
Type: string
Title:
Type
Maximum Length:255
Type of federal DATA Act balance.
Nested Schema : Federal DATA Act Balance Calculation Totals
Type:
array
Title:
Federal DATA Act Balance Calculation Totals
The federal DATA Act balance calculations totals enables users to manage DATA Act balance calculation with type total.
Show Source
Nested Schema : Federal DATA Act Balance Calculation USSGL Accounts
Type:
array
Title:
Federal DATA Act Balance Calculation USSGL Accounts
The federal DATA Act balance calculation USSGL accounts enables users to manage USSGL accounts with type balance.
Show Source
Nested Schema : schema
Type:
Show Source
object
-
BalanceCalculationId: integer
(int64)
Title:
Balance Calculation ID
The unique identifier of the DATA Act balance calculation of federal DATA Act balance calculations. -
BalanceHeaderId: integer
(int64)
Title:
Balance Header ID
The unique identifier of the DATA Act balance calculation header of federal DATA Act balance calculations of type total. -
BalanceName: string
Title:
Balance Name
Maximum Length:255
Balance name of the federal DATA Act balance calculation. -
FromDate: string
(date)
Title:
From Date
The period start date of the federal DATA Act balance calculation. -
Operator: string
Title:
Operator
Maximum Length:255
Operator name of the federal DATA Act balance calculation. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
Sequence number of the federal DATA Act balance calculation. -
ToDate: string
(date)
Title:
To Date
The period end date of the federal DATA Act balance calculation.
Nested Schema : schema
Type:
Show Source
object
-
BalanceCalculationUSSGLId: integer
(int64)
Title:
Balance Calculation USSGL ID
The unique identifier of the DATA Act balance calculation USSGL accounts of federal DATA Act balance calculation USSGL accounts. -
BalanceHeaderId: integer
(int64)
Title:
Balance Header ID
The unique identifier of the header of federal DATA Act balance calculation USSGL accounts of type balances. -
BalanceType: string
Title:
Balance Type
Maximum Length:255
Balance type of the federal DATA Act balance calculation USSGL accounts. -
FromDate: string
(date)
Title:
From Date
The period start date of the federal DATA Act balance calculation USSGL accounts. -
Operator: string
Title:
Operator
Maximum Length:255
Operator name of the federal DATA Act balance calculation USSGL accounts. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
Sequence number of the federal DATA Act balance calculation USSGL accounts. -
ToDate: string
(date)
Title:
To Date
The period end date of the federal DATA Act balance calculation USSGL accounts. -
USSGLAccount: string
Title:
USSGL Account
Maximum Length:6
USSGL account of the federal DATA Act balance calculation USSGL accounts. -
USSGLAccountDescription: string
Title:
USSGL Account Description
Maximum Length:255
USSGL account description of the federal DATA Act balance calculation USSGL accounts.
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 : fedDATAActBalances-item-response
Type:
Show Source
object
-
BalanceFiles: string
Title:
Balance Files
Read Only:true
Maximum Length:255
Balance files of the federal DATA Act balances. -
BalanceHeaderId: integer
(int64)
Title:
Balance Header ID
The unique identifier of the federal DATA Act balance. -
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. -
fedDATAActBalanceCalculationTotals: array
Federal DATA Act Balance Calculation Totals
Title:
Federal DATA Act Balance Calculation Totals
The federal DATA Act balance calculations totals enables users to manage DATA Act balance calculation with type total. -
fedDATAActBalanceCalculationUSSGLAccounts: array
Federal DATA Act Balance Calculation USSGL Accounts
Title:
Federal DATA Act Balance Calculation USSGL Accounts
The federal DATA Act balance calculation USSGL accounts enables users to manage USSGL accounts with type balance. -
FileA: string
Title:
File A
Maximum Length:255
File A of the federal DATA Act balance. -
FileB: string
Title:
File B
Maximum Length:255
File B of the federal DATA Act balance. -
FileC: string
Title:
File C
Maximum Length:255
File C of the federal DATA Act balance. -
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. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Name: string
Title:
Name
Maximum Length:120
Name of the federal DATA Act balance. -
Type: string
Title:
Type
Maximum Length:255
Type of federal DATA Act balance.
Nested Schema : Federal DATA Act Balance Calculation Totals
Type:
array
Title:
Federal DATA Act Balance Calculation Totals
The federal DATA Act balance calculations totals enables users to manage DATA Act balance calculation with type total.
Show Source
Nested Schema : Federal DATA Act Balance Calculation USSGL Accounts
Type:
array
Title:
Federal DATA Act Balance Calculation USSGL Accounts
The federal DATA Act balance calculation USSGL accounts enables users to manage USSGL accounts with type balance.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : fedDATAActBalances-fedDATAActBalanceCalculationTotals-item-response
Type:
Show Source
object
-
BalanceCalculationId: integer
(int64)
Title:
Balance Calculation ID
The unique identifier of the DATA Act balance calculation of federal DATA Act balance calculations. -
BalanceHeaderId: integer
(int64)
Title:
Balance Header ID
The unique identifier of the DATA Act balance calculation header of federal DATA Act balance calculations of type total. -
BalanceName: string
Title:
Balance Name
Maximum Length:255
Balance name of the federal DATA Act balance calculation. -
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. -
FromDate: string
(date)
Title:
From Date
The period start date of the federal DATA Act balance calculation. -
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. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Operator: string
Title:
Operator
Maximum Length:255
Operator name of the federal DATA Act balance calculation. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
Sequence number of the federal DATA Act balance calculation. -
ToDate: string
(date)
Title:
To Date
The period end date of the federal DATA Act balance calculation.
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 : fedDATAActBalances-fedDATAActBalanceCalculationUSSGLAccounts-item-response
Type:
Show Source
object
-
BalanceCalculationUSSGLId: integer
(int64)
Title:
Balance Calculation USSGL ID
The unique identifier of the DATA Act balance calculation USSGL accounts of federal DATA Act balance calculation USSGL accounts. -
BalanceHeaderId: integer
(int64)
Title:
Balance Header ID
The unique identifier of the header of federal DATA Act balance calculation USSGL accounts of type balances. -
BalanceType: string
Title:
Balance Type
Maximum Length:255
Balance type of the federal DATA Act balance calculation USSGL accounts. -
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. -
FromDate: string
(date)
Title:
From Date
The period start date of the federal DATA Act balance calculation USSGL accounts. -
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. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The user who last updated the record. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
Operator: string
Title:
Operator
Maximum Length:255
Operator name of the federal DATA Act balance calculation USSGL accounts. -
SequenceNumber: integer
(int32)
Title:
Sequence Number
Sequence number of the federal DATA Act balance calculation USSGL accounts. -
ToDate: string
(date)
Title:
To Date
The period end date of the federal DATA Act balance calculation USSGL accounts. -
USSGLAccount: string
Title:
USSGL Account
Maximum Length:6
USSGL account of the federal DATA Act balance calculation USSGL accounts. -
USSGLAccountDescription: string
Title:
USSGL Account Description
Maximum Length:255
USSGL account description of the federal DATA Act balance calculation USSGL accounts.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- fedDATAActBalanceCalculationTotals
-
Parameters:
- BalanceHeaderId:
$request.path.BalanceHeaderId
The federal DATA Act balance calculations totals enables users to manage DATA Act balance calculation with type total. - BalanceHeaderId:
- fedDATAActBalanceCalculationUSSGLAccounts
-
Parameters:
- BalanceHeaderId:
$request.path.BalanceHeaderId
The federal DATA Act balance calculation USSGL accounts enables users to manage USSGL accounts with type balance. - BalanceHeaderId:
Examples
The following example shows how to Create a DATA Act Balance Name with Type as Balances 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:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances"
Request Body Example
The following shows an example of the request body in JSON format.
{ "Name": "Balances5006", "Type": "Balances", "FileA": "Yes", "FileB": "Yes", "FileC": "Yes" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "BalanceHeaderId": "300100613658592", "Name": "BalancesNK5006", "Type": "Balances", "FileA": "Yes", "FileB": "Yes", "FileC": "Yes", "BalanceFiles": null, "CreationDate": "2023-11-06T14:09:56+00:00", "CreatedBy": "usersname", "LastUpdatedBy": "usersname", "LastUpdateDate": "2023-11-06T14:09:56.387+00:00", "LastUpdateLogin": "093ADF3293307CD0E063A46315ACC1CD", "@context": { "key": "300100613658592", "headers": { "ETag": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" }, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613658592", "name": "fedDATAActBalances", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613658592", "name": "fedDATAActBalances", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613658592/child/fedDATAActBalanceCalculationTotals", "name": "fedDATAActBalanceCalculationTotals", "kind": "collection" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com:443/fscmRestApi/resources/11.13.18.05/fedDATAActBalances/300100613658592/child/fedDATAActBalanceCalculationUSSGLAccounts", "name": "fedDATAActBalanceCalculationUSSGLAccounts", "kind": "collection" } ] } }