Create a fee schedule
post
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorFeeSchedules-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the fee schedule. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the fee schedule was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:50A description of the fee schedule. -
DftFeeItemId(optional):
string
Title:
Default Fee ItemMaximum Length:30The default fee item is used if the fee item in the decision model does not match any fee items in the common fee item table. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date of the fee schedule. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date of the fee schedule. -
FeeLine(optional):
array Fee Lines
Title:
Fee LinesThe fee schedules resource is used to view, create, delete, or modify fee schedules. A fee schedule is used to define how the fees are calculated based on decision models defined in Oracle Autonomous Integration Cloud (OIC). For a given fee schedule, there may be one or more fee lines. -
FeeScheduleId(optional):
string
Title:
Fee ScheduleMaximum Length:20A unique name that identifies a fee schedule. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the fee schedule. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the fee schedule was last updated. -
links(optional):
array Items
Title:
ItemsLink Relations -
RefundFeeItemId(optional):
string
Title:
Refund Fee ItemMaximum Length:30The fee item used for refunds.
Nested Schema : Fee Lines
Type:
arrayTitle:
Fee LinesThe fee schedules resource is used to view, create, delete, or modify fee schedules. A fee schedule is used to define how the fees are calculated based on decision models defined in Oracle Autonomous Integration Cloud (OIC). For a given fee schedule, there may be one or more fee lines.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the fee line. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the fee line was created. -
CurrencyCode(optional):
string
Title:
CurrencyMaximum Length:3The default currency code from the COM_AGENCY table. For now, this field is display-only. -
DmnModelName(optional):
string
Title:
Model NameMaximum Length:1000The fee decision model name. -
DmnServiceName(optional):
string
Title:
Service NameMaximum Length:1000The OIC REST service name for the deployed model. -
DmnSpaceId(optional):
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(optional):
string
Title:
Space NameMaximum Length:1000The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag(optional):
string
Title:
VersionMaximum Length:1000The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date of the fee schedule. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date of the fee schedule. -
FeeScheduleId(optional):
string
Title:
Fee ScheduleMaximum Length:20A unique name that identifies a fee schedule. -
FeeScheduleLine(optional):
integer(int64)
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(optional):
array Fee Schedule Map Data
Title:
Fee Schedule Map DataThe fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the fee line was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the fee line. -
links(optional):
array Items
Title:
ItemsLink Relations -
MapFeeAmount(optional):
string
Title:
Map Fee AmountMaximum Length:50The output resource name for fee amount to be stored. -
MapFeeItem(optional):
string
Title:
Map Fee ItemMaximum Length:50The output resource name for the fee item to be stored. -
MappingSource(optional):
string
Title:
Mapping SourceMaximum Length:10The source transaction that requires field mapping to calculate fees. -
PayNow(optional):
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(optional):
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(optional):
string
Maximum Length:
1Indicates whether this fee line is used for the original fees. The default value is yes. -
UseRenew(optional):
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 lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
The identifier for the public sector agency to which this fee schedule map belongs.
-
CreatedBy(optional):
string
Maximum Length:
64The user who created the fee schedule map. -
CreatedByLogin(optional):
string
Maximum Length:
32The user who logged in the fee schedule map. -
CreationDate(optional):
string(date-time)
The date when the fee schedule map was created.
-
EffectiveEndDate(optional):
string(date)
The end date of the fee schedule map.
-
EffectiveStartDate(optional):
string(date)
The start date of the fee schedule map.
-
FeeScheduleId(optional):
string
Maximum Length:
20A unique name that identifies a fee schedule. -
FeeScheduleLine(optional):
integer(int64)
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(optional):
integer(int64)
The sequence number for the field in the mapping table.
-
LastUpdateDate(optional):
string(date-time)
The date when the fee schedule map was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the fee schedule map. -
LastUpdateLogin(optional):
string
Maximum Length:
32The logged in user who last updated the fee schedule map. -
links(optional):
array Items
Title:
ItemsLink Relations -
MappingType(optional):
string
Maximum Length:
10The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname(optional):
string
Maximum Length:
50The DMN input field name. -
SourceFieldtype(optional):
string
Maximum Length:
30The data type of the DMN input field name. -
SourceLabel(optional):
string
Maximum Length:
200The label for the DMN input field name. -
SourceObjectname(optional):
string
Maximum Length:
200The name of the source business object for an array. -
TargetFieldname(optional):
string
Maximum Length:
50This field name in the transaction table that contains the DMN input value. -
TargetLabel(optional):
string
Maximum Length:
200The label for the target field name. -
TargetObjectname(optional):
string
Maximum Length:
200The name of the target business object for an array.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorFeeSchedules-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the fee schedule. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the fee schedule was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:50A description of the fee schedule. -
DftFeeItemId(optional):
string
Title:
Default Fee ItemMaximum Length:30The default fee item is used if the fee item in the decision model does not match any fee items in the common fee item table. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date of the fee schedule. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date of the fee schedule. -
FeeLine(optional):
array Fee Lines
Title:
Fee LinesThe fee schedules resource is used to view, create, delete, or modify fee schedules. A fee schedule is used to define how the fees are calculated based on decision models defined in Oracle Autonomous Integration Cloud (OIC). For a given fee schedule, there may be one or more fee lines. -
FeeScheduleId(optional):
string
Title:
Fee ScheduleMaximum Length:20A unique name that identifies a fee schedule. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe user who last updated the fee schedule. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The date when the fee schedule was last updated. -
links(optional):
array Items
Title:
ItemsLink Relations -
RefundFeeItemId(optional):
string
Title:
Refund Fee ItemMaximum Length:30The fee item used for refunds.
Nested Schema : Fee Lines
Type:
arrayTitle:
Fee LinesThe fee schedules resource is used to view, create, delete, or modify fee schedules. A fee schedule is used to define how the fees are calculated based on decision models defined in Oracle Autonomous Integration Cloud (OIC). For a given fee schedule, there may be one or more fee lines.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the fee line. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the fee line was created. -
CurrencyCode(optional):
string
Title:
CurrencyMaximum Length:3The default currency code from the COM_AGENCY table. For now, this field is display-only. -
DmnModelName(optional):
string
Title:
Model NameMaximum Length:1000The fee decision model name. -
DmnServiceName(optional):
string
Title:
Service NameMaximum Length:1000The OIC REST service name for the deployed model. -
DmnSpaceId(optional):
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(optional):
string
Title:
Space NameMaximum Length:1000The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag(optional):
string
Title:
VersionMaximum Length:1000The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date of the fee schedule. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date of the fee schedule. -
FeeScheduleId(optional):
string
Title:
Fee ScheduleMaximum Length:20A unique name that identifies a fee schedule. -
FeeScheduleLine(optional):
integer(int64)
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(optional):
array Fee Schedule Map Data
Title:
Fee Schedule Map DataThe fee lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the fee line was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The user who last updated the fee line. -
links(optional):
array Items
Title:
ItemsLink Relations -
MapFeeAmount(optional):
string
Title:
Map Fee AmountMaximum Length:50The output resource name for fee amount to be stored. -
MapFeeItem(optional):
string
Title:
Map Fee ItemMaximum Length:50The output resource name for the fee item to be stored. -
MappingSource(optional):
string
Title:
Mapping SourceMaximum Length:10The source transaction that requires field mapping to calculate fees. -
PayNow(optional):
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(optional):
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(optional):
string
Maximum Length:
1Indicates whether this fee line is used for the original fees. The default value is yes. -
UseRenew(optional):
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 lines resource is used to view, create, delete, or modify fee lines. A fee line is used to define which decision model in OIC is used for the current fee schedule.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
The identifier for the public sector agency to which this fee schedule map belongs.
-
CreatedBy(optional):
string
Maximum Length:
64The user who created the fee schedule map. -
CreatedByLogin(optional):
string
Maximum Length:
32The user who logged in the fee schedule map. -
CreationDate(optional):
string(date-time)
The date when the fee schedule map was created.
-
EffectiveEndDate(optional):
string(date)
The end date of the fee schedule map.
-
EffectiveStartDate(optional):
string(date)
The start date of the fee schedule map.
-
FeeScheduleId(optional):
string
Maximum Length:
20A unique name that identifies a fee schedule. -
FeeScheduleLine(optional):
integer(int64)
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(optional):
integer(int64)
The sequence number for the field in the mapping table.
-
LastUpdateDate(optional):
string(date-time)
The date when the fee schedule map was last updated.
-
LastUpdatedBy(optional):
string
Maximum Length:
64The user who last updated the fee schedule map. -
LastUpdateLogin(optional):
string
Maximum Length:
32The logged in user who last updated the fee schedule map. -
links(optional):
array Items
Title:
ItemsLink Relations -
MappingType(optional):
string
Maximum Length:
10The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname(optional):
string
Maximum Length:
50The DMN input field name. -
SourceFieldtype(optional):
string
Maximum Length:
30The data type of the DMN input field name. -
SourceLabel(optional):
string
Maximum Length:
200The label for the DMN input field name. -
SourceObjectname(optional):
string
Maximum Length:
200The name of the source business object for an array. -
TargetFieldname(optional):
string
Maximum Length:
50This field name in the transaction table that contains the DMN input value. -
TargetLabel(optional):
string
Maximum Length:
200The label for the target field name. -
TargetObjectname(optional):
string
Maximum Length:
200The name of the target business object for an array.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.