Create a federal attribute supplemental rule line
post
/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines
Request
Path Parameters
-
SupplRuleHeaderId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
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
-
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. -
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(required): string
Title:
From Period
Maximum Length:15
Name of the starting period associated with the federal supplemental rule line. -
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 : schema
Type:
Show Source
object
-
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 : schema
Type:
Show Source
object
-
Code: string
Title:
Exception Code
Maximum Length:30
Code of the federal attribute supplemental rule exception message. -
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. -
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 : fedAttributeSupplementalRules-fedAttributeSupplementalRuleLines-fedAttributeSupplementalRuleFilters-item-post-request
Type:
Show Source
object
-
AccountingSegment: string
Title:
Accounting Segment
Maximum Length:255
Accounting segment of the federal attribute supplemental rule filter. -
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. -
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.
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 : 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
- fedAttributeSupplementalRuleAllocations
-
Parameters:
- SupplRuleHeaderId:
$request.path.SupplRuleHeaderId
- SupplRuleLineId:
$request.path.SupplRuleLineId
The federal attribute supplemental rule allocations enables users to manage supplemental rule allocations. - SupplRuleHeaderId:
- fedAttributeSupplementalRuleExceptionMessages
-
Parameters:
- SupplRuleHeaderId:
$request.path.SupplRuleHeaderId
- SupplRuleLineId:
$request.path.SupplRuleLineId
The federal attribute supplemental rule exception messages enables users to manage supplemental rule exception messages. - SupplRuleHeaderId:
- fedAttributeSupplementalRuleFilters
-
Parameters:
- SupplRuleHeaderId:
$request.path.SupplRuleHeaderId
- SupplRuleLineId:
$request.path.SupplRuleLineId
The federal attribute supplemental rule filters enables user to define and manage the federal attribute supplemental rule filters. - SupplRuleHeaderId:
Examples
The following example shows how to create a federal attribute supplemental rule line by submitting a POST/ request on the REST resource using cURL.
curl -i -u "<username>:<password>" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d <payload> https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/{SupplRuleHeaderId}/child/fedAttributeSupplementalRuleLines
Request Body Example
The following shows an example of the request body in JSON format.
{ "ReportingCodeValue": "A", "FromPeriod": "Oct-21", "ToPeriod": "Sep-22" }
Response Body Example
The following shows an example of the response body in JSON format.
{ "SupplRuleLineId": 300100588708778, "ReportingCodeValue": "A", "Description": "Quarterly Apportionment", "FromPeriod": "Oct-21", "ToPeriod": "Sep-22", "Allocate": null, "ValidationStatus": null, "CreationDate": "2024-03-11T11:34:45+00:00", "CreatedBy": "username", "LastUpdatedBy": "username", "LastUpdateDate": "2024-03-11T11:34:45.309+00:00", "links": [ { "rel": "self", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432/child/fedAttributeSupplementalRuleLines/300100588708778", "name": "fedAttributeSupplementalRuleLines", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432/child/fedAttributeSupplementalRuleLines/300100588708778", "name": "fedAttributeSupplementalRuleLines", "kind": "item" }, { "rel": "parent", "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/300100588708778/child/fedAttributeSupplementalRuleAllocations", "name": "fedAttributeSupplementalRuleAllocations", "kind": "collection" }, { "rel": "child", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432/child/fedAttributeSupplementalRuleLines/300100588708778/child/fedAttributeSupplementalRuleExceptionMessages", "name": "fedAttributeSupplementalRuleExceptionMessages", "kind": "collection" }, { "rel": "child", "href": "https:// servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/fedAttributeSupplementalRules/300100588674432/child/fedAttributeSupplementalRuleLines/300100588708778/child/fedAttributeSupplementalRuleFilters", "name": "fedAttributeSupplementalRuleFilters", "kind": "collection" } ] }