Create a fee line
post
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine
Request
Path Parameters
-
publicSectorFeeSchedulesUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate and EffectiveEndDate ---for the Fee Schedules resource and used to uniquely identify an instance of Fee Schedules. The client should not generate the hash key value. Instead, the client should query on the Fee Schedules collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Schedules.
For example: publicSectorFeeSchedules?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
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
The following table describes the body parameters in the request for this task.
Root Schema : schema
Type:
Show Source
object-
AgencyId: integer
Title:
Agency IDDefault Value:1The identifier for the public sector agency to which this fee schedule belongs. -
CurrencyCode(required): string
Title:
CurrencyMaximum Length:3The default currency code from the COM_AGENCY table. For now, this field is display-only. -
DmnModelName(required): string
Title:
Model NameMaximum Length:1000The fee decision model name. -
DmnServiceName(required): string
Title:
Service NameMaximum Length:1000The OIC REST service name for the deployed model. -
DmnSpaceId(required): string
Title:
Space IDMaximum Length:1000The internal ID for the Oracle Autonomous Integration Cloud (OIC) space. This is the workflow space that OIC actually uses to reference the decision model; however, it is not exposed to the user. -
DmnSpaceName(required): string
Title:
Space NameMaximum Length:1000The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag(required): string
Title:
VersionMaximum Length:1000The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate(required): string
(date)
Title:
Effective End DateThe end date of the fee schedule. -
EffectiveStartDate(required): string
(date)
Title:
Effective Start DateThe start date of the fee schedule. -
FeeScheduleId(required): string
Title:
Fee ScheduleMaximum Length:20A unique name that identifies a fee schedule. -
FeeScheduleLine(required): integer
Title:
Fee ItemsThe line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines. -
FeeScheduleMapD: array
Fee Schedule Map Data
Title:
Fee Schedule Map DataThe fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design. -
MapFeeAmount(required): string
Title:
Map Fee AmountMaximum Length:50The output resource name for fee amount to be stored. -
MapFeeItem(required): string
Title:
Map Fee ItemMaximum Length:50The output resource name for the fee item to be stored. -
MapFeeReference: string
Title:
Map Fee ReferenceMaximum Length:50The identifier of the map fee reference for the decision model. -
MappingSource(required): string
Title:
Mapping SourceMaximum Length:10The source transaction that requires field mapping to calculate fees. -
PayNow(required): string
Title:
Pay NowMaximum Length:1Indicates whether the fee item is payable upon submission of the application or not. The default value is no. -
UseAmend: string
Maximum Length:
1Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value. -
UseOrig: string
Maximum Length:
1Indicates whether this fee line is used for the original fees. The default value is yes. -
UseRenew: string
Maximum Length:
1Indicates whether this fee line is used for renewal fees. This field is for future use. There is no default value.
Nested Schema : Fee Schedule Map Data
Type:
arrayTitle:
Fee Schedule Map DataThe fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-post-request
Type:
Show Source
object-
AgencyId: integer
The identifier for the public sector agency to which this fee schedule map belongs.
-
EffectiveEndDate: string
(date)
The end date of the fee schedule map.
-
EffectiveStartDate: string
(date)
The start date of the fee schedule map.
-
FeeScheduleId: string
Maximum Length:
20A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.
-
FieldNum: integer
The sequence number for the field in the mapping table.
-
MappingType: string
Maximum Length:
10The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname: string
Maximum Length:
50The DMN input field name. -
SourceFieldtype: string
Maximum Length:
30The data type of the DMN input field name. -
SourceLabel: string
Maximum Length:
200The label for the DMN input field name. -
SourceObjectname: string
Maximum Length:
200The name of the source business object for an array. -
TargetFieldname: string
Maximum Length:
50This field name in the transaction table that contains the DMN input value. -
TargetLabel: string
Maximum Length:
200The label for the target field name. -
TargetObjectname: string
Maximum Length:
200The name of the target business object for an array.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorFeeSchedules-FeeLine-item-response
Type:
Show Source
object-
AgencyId: integer
Title:
Agency IDDefault Value:1The identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy: string
Title:
Created ByRead Only:trueMaximum Length:64The user who created the fee line. -
CreationDate: string
(date-time)
Title:
Creation DateRead Only:trueThe date when the fee line was created. -
CurrencyCode: string
Title:
CurrencyMaximum Length:3The default currency code from the COM_AGENCY table. For now, this field is display-only. -
DmnModelName: string
Title:
Model NameMaximum Length:1000The fee decision model name. -
DmnServiceName: string
Title:
Service NameMaximum Length:1000The OIC REST service name for the deployed model. -
DmnSpaceId: string
Title:
Space IDMaximum Length:1000The internal ID for the Oracle Autonomous Integration Cloud (OIC) space. This is the workflow space that OIC actually uses to reference the decision model; however, it is not exposed to the user. -
DmnSpaceName: string
Title:
Space NameMaximum Length:1000The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag: string
Title:
VersionMaximum Length:1000The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate: string
(date)
Title:
Effective End DateThe end date of the fee schedule. -
EffectiveStartDate: string
(date)
Title:
Effective Start DateThe start date of the fee schedule. -
FeeScheduleId: string
Title:
Fee ScheduleMaximum Length:20A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
Title:
Fee ItemsThe line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines. -
FeeScheduleMapD: array
Fee Schedule Map Data
Title:
Fee Schedule Map DataThe fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design. -
LastUpdateDate: string
(date-time)
Title:
Last Updated DateRead Only:trueThe date when the fee line was last updated. -
LastUpdatedBy: string
Title:
Last Updated ByRead Only:trueMaximum Length:64The user who last updated the fee line. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MapFeeAmount: string
Title:
Map Fee AmountMaximum Length:50The output resource name for fee amount to be stored. -
MapFeeItem: string
Title:
Map Fee ItemMaximum Length:50The output resource name for the fee item to be stored. -
MapFeeReference: string
Title:
Map Fee ReferenceMaximum Length:50The identifier of the map fee reference for the decision model. -
MappingSource: string
Title:
Mapping SourceMaximum Length:10The source transaction that requires field mapping to calculate fees. -
PayNow: string
Title:
Pay NowMaximum Length:1Indicates whether the fee item is payable upon submission of the application or not. The default value is no. -
UseAmend: string
Maximum Length:
1Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value. -
UseOrig: string
Maximum Length:
1Indicates whether this fee line is used for the original fees. The default value is yes. -
UseRenew: string
Maximum Length:
1Indicates whether this fee line is used for renewal fees. This field is for future use. There is no default value.
Nested Schema : Fee Schedule Map Data
Type:
arrayTitle:
Fee Schedule Map DataThe fee schedule map data resource is used to view, create, delete, or modify the data. The fee mapping is to store the mapping data and to calculate the DMN fee outside of the form design.
Show Source
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response
Type:
Show Source
object-
AgencyId: integer
The identifier for the public sector agency to which this fee schedule map belongs.
-
CreatedBy: string
Read Only:
trueMaximum Length:64The user who created the fee schedule map. -
CreatedByLogin: string
Read Only:
trueMaximum Length:32The user who logged in the fee schedule map. -
CreationDate: string
(date-time)
Read Only:
trueThe date when the fee schedule map was created. -
EffectiveEndDate: string
(date)
The end date of the fee schedule map.
-
EffectiveStartDate: string
(date)
The start date of the fee schedule map.
-
FeeScheduleId: string
Maximum Length:
20A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
The line number for the current fee schedule. When the user adds a new line, it is incremented up to the maximum number of fee schedule lines.
-
FieldNum: integer
The sequence number for the field in the mapping table.
-
LastUpdateDate: string
(date-time)
Read Only:
trueThe date when the fee schedule map was last updated. -
LastUpdatedBy: string
Read Only:
trueMaximum Length:64The user who last updated the fee schedule map. -
LastUpdateLogin: string
Read Only:
trueMaximum Length:32The logged in user who last updated the fee schedule map. -
links: array
Links
Title:
LinksThe link relations associated with the resource instance. -
MappingType: string
Maximum Length:
10The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname: string
Maximum Length:
50The DMN input field name. -
SourceFieldtype: string
Maximum Length:
30The data type of the DMN input field name. -
SourceLabel: string
Maximum Length:
200The label for the DMN input field name. -
SourceObjectname: string
Maximum Length:
200The name of the source business object for an array. -
TargetFieldname: string
Maximum Length:
50This field name in the transaction table that contains the DMN input value. -
TargetLabel: string
Maximum Length:
200The label for the target field name. -
TargetObjectname: string
Maximum Length:
200The name of the target business object for an array.
Nested Schema : Links
Type:
arrayTitle:
LinksThe link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object-
href: string
Title:
hyperlink referenceThe URI to the related resource. -
kind: string
Title:
kindAllowed Values:[ "collection", "item", "describe", "other" ]The kind of the related resource. -
name: string
Title:
nameThe name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relationAllowed 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
- FeeScheduleMapD
-
Parameters:
- FeeLineUniqID:
$request.path.FeeLineUniqID - publicSectorFeeSchedulesUniqID:
$request.path.publicSectorFeeSchedulesUniqID
(Resource of FeeScheduleMapD) - FeeLineUniqID: