Get all fee schedules
get
/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules
Request
Query Parameters
-
effectiveDate: string
This query parameter is used to fetch resources which are effective dated as of the specified start date. The value of this query parameter is a string having a date in yyyy-MM-dd format
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- FeeScheduleRowFinder: Finds a fee schedule using the effective date framework.
Finder Variables:- AgencyId; string; The identifier for the public sector agency to which this fee schedule belongs.
- SysEffectiveDate; object.
- PrimaryKey: Finds a fee schedule using the specified agency identifier, fee schedule ID, and effective date.
Finder Variables:- AgencyId; integer; The identifier for the public sector agency to which this fee schedule belongs.
- EffectiveEndDate; string; The end date of the fee schedule.
- EffectiveStartDate; string; The start date of the fee schedule.
- FeeScheduleId; string; A unique name that identifies a fee schedule.
- simpleSearchFinder: Finds the fee schedule that matches the specified search criteria.
Finder Variables:- value; string; Finds the fee schedule that matches the specified search value.
- FeeScheduleRowFinder: Finds a fee schedule using the effective date framework.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- AgencyId; integer; The identifier for the public sector agency to which this fee schedule belongs.
- CreatedBy; string; The user who created the fee schedule.
- CreationDate; string; The date when the fee schedule was created.
- Description; string; A description of the fee schedule.
- DftFeeItemId; string; 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; The end date of the fee schedule.
- EffectiveStartDate; string; The start date of the fee schedule.
- FeeScheduleId; string; A unique name that identifies a fee schedule.
- LastUpdateDate; string; The user who last updated the fee schedule.
- LastUpdatedBy; string; The date when the fee schedule was last updated.
- RefundFeeItemId; string; The fee item used for refunds.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
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
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested 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.