Create a fee schedule
post
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
Request
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this fee schedule belongs. -
Description(required): string
Title:
Description
Maximum Length:50
A description of the fee schedule. -
DftFeeItemId(required): string
Title:
Default Fee Item
Maximum Length:30
The 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(required): string
(date)
Title:
Effective End Date
The end date of the fee schedule. -
EffectiveStartDate(required): string
(date)
Title:
Effective Start Date
The start date of the fee schedule. -
FeeLine: array
Fee Lines
Title:
Fee Lines
The 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. -
FeeScheduleId(required): string
Title:
Fee Schedule
Maximum Length:20
A unique name that identifies a fee schedule. -
RefundFeeItemId: string
Title:
Refund Fee Item
Maximum Length:30
Default Value:MISCELLANEOUS
The fee item used for refunds.
Nested Schema : Fee Lines
Type:
array
Title:
Fee Lines
The 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 : schema
Type:
Show Source
object
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this fee schedule belongs. -
CurrencyCode(required): string
Title:
Currency
Maximum Length:3
The default currency code from the COM_AGENCY table. For now, this field is display-only. -
DmnModelName(required): string
Title:
Model Name
Maximum Length:1000
The fee decision model name. -
DmnServiceName(required): string
Title:
Service Name
Maximum Length:1000
The OIC REST service name for the deployed model. -
DmnSpaceId: string
Title:
Space ID
Maximum Length:1000
The 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 Name
Maximum Length:1000
The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag(required): string
Title:
Version
Maximum Length:1000
The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate(required): string
(date)
Title:
Effective End Date
The end date of the fee schedule. -
EffectiveStartDate(required): string
(date)
Title:
Effective Start Date
The start date of the fee schedule. -
FeeScheduleId(required): string
Title:
Fee Schedule
Maximum Length:20
A unique name that identifies a fee schedule. -
FeeScheduleLine(required): integer
Title:
Fee Items
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. -
FeeScheduleMapD: array
Fee Schedule Map Data
Title:
Fee Schedule Map Data
The 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 Amount
Maximum Length:50
The output resource name for fee amount to be stored. -
MapFeeItem(required): string
Title:
Map Fee Item
Maximum Length:50
The output resource name for the fee item to be stored. -
MapFeeReference: string
Title:
Map Fee Reference
Maximum Length:50
The identifier of the map fee reference for the decision model. -
MappingSource(required): string
Title:
Mapping Source
Maximum Length:10
The source transaction that requires field mapping to calculate fees. -
PayNow(required): string
Title:
Pay Now
Maximum Length:1
Indicates whether the fee item is payable upon submission of the application or not. The default value is no. -
UseAmend: string
Maximum Length:
1
Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value. -
UseOrig: string
Maximum Length:
1
Indicates whether this fee line is used for the original fees. The default value is yes. -
UseRenew: string
Maximum Length:
1
Indicates 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:
array
Title:
Fee Schedule Map Data
The 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 : schema
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:
20
A 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:
10
The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname: string
Maximum Length:
50
The DMN input field name. -
SourceFieldtype: string
Maximum Length:
30
The data type of the DMN input field name. -
SourceLabel: string
Maximum Length:
200
The label for the DMN input field name. -
SourceObjectname: string
Maximum Length:
200
The name of the source business object for an array. -
TargetFieldname: string
Maximum Length:
50
This field name in the transaction table that contains the DMN input value. -
TargetLabel: string
Maximum Length:
200
The label for the target field name. -
TargetObjectname: string
Maximum Length:
200
The 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:
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 : publicSectorFeeSchedules-item-response
Type:
Show Source
object
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the fee schedule. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the fee schedule was created. -
Description: string
Title:
Description
Maximum Length:50
A description of the fee schedule. -
DftFeeItemId: string
Title:
Default Fee Item
Maximum Length:30
The 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: string
(date)
Title:
Effective End Date
The end date of the fee schedule. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The start date of the fee schedule. -
FeeLine: array
Fee Lines
Title:
Fee Lines
The 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. -
FeeScheduleId: string
Title:
Fee Schedule
Maximum Length:20
A unique name that identifies a fee schedule. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The user who last updated the fee schedule. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The date when the fee schedule was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RefundFeeItemId: string
Title:
Refund Fee Item
Maximum Length:30
Default Value:MISCELLANEOUS
The fee item used for refunds.
Nested Schema : Fee Lines
Type:
array
Title:
Fee Lines
The 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 : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorFeeSchedules-FeeLine-item-response
Type:
Show Source
object
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency to which this fee schedule belongs. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the fee line. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the fee line was created. -
CurrencyCode: string
Title:
Currency
Maximum Length:3
The default currency code from the COM_AGENCY table. For now, this field is display-only. -
DmnModelName: string
Title:
Model Name
Maximum Length:1000
The fee decision model name. -
DmnServiceName: string
Title:
Service Name
Maximum Length:1000
The OIC REST service name for the deployed model. -
DmnSpaceId: string
Title:
Space ID
Maximum Length:1000
The 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 Name
Maximum Length:1000
The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag: string
Title:
Version
Maximum Length:1000
The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The end date of the fee schedule. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The start date of the fee schedule. -
FeeScheduleId: string
Title:
Fee Schedule
Maximum Length:20
A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
Title:
Fee Items
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. -
FeeScheduleMapD: array
Fee Schedule Map Data
Title:
Fee Schedule Map Data
The 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 Date
Read Only:true
The date when the fee line was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the fee line. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MapFeeAmount: string
Title:
Map Fee Amount
Maximum Length:50
The output resource name for fee amount to be stored. -
MapFeeItem: string
Title:
Map Fee Item
Maximum Length:50
The output resource name for the fee item to be stored. -
MapFeeReference: string
Title:
Map Fee Reference
Maximum Length:50
The identifier of the map fee reference for the decision model. -
MappingSource: string
Title:
Mapping Source
Maximum Length:10
The source transaction that requires field mapping to calculate fees. -
PayNow: string
Title:
Pay Now
Maximum Length:1
Indicates whether the fee item is payable upon submission of the application or not. The default value is no. -
UseAmend: string
Maximum Length:
1
Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value. -
UseOrig: string
Maximum Length:
1
Indicates whether this fee line is used for the original fees. The default value is yes. -
UseRenew: string
Maximum Length:
1
Indicates 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:
array
Title:
Fee Schedule Map Data
The 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:
array
Title:
Links
The 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.
-
CreationDate: string
(date-time)
Read Only:
true
The 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:
20
A 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:
true
The date when the fee schedule map was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MappingType: string
Maximum Length:
10
The identifier to distinguish between the IN and OUT mapping. -
SourceFieldname: string
Maximum Length:
50
The DMN input field name. -
SourceFieldtype: string
Maximum Length:
30
The data type of the DMN input field name. -
SourceLabel: string
Maximum Length:
200
The label for the DMN input field name. -
SourceObjectname: string
Maximum Length:
200
The name of the source business object for an array. -
TargetFieldname: string
Maximum Length:
50
This field name in the transaction table that contains the DMN input value. -
TargetLabel: string
Maximum Length:
200
The label for the target field name. -
TargetObjectname: string
Maximum Length:
200
The name of the target business object for an array.
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
- FeeLine
-
Parameters:
- publicSectorFeeSchedulesUniqID:
$request.path.publicSectorFeeSchedulesUniqID
The 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. - publicSectorFeeSchedulesUniqID: