Get all fee line decision models
get
/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineModels
Request
Query Parameters
-
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:- PrimaryKey: Finds a fee line decision model using the specified record type identifier, fee schedule ID, and fee schedule line.
Finder Variables:- EffectiveEndDate; string; The date at the end of the date range within which the record is effective.
- EffectiveStartDate; string; The date at the beginning of the date range within which the record is effective.
- FeeScheduleId; string; The unique name that identifies a fee schedule.
- FeeScheduleLine; integer; The line number for the fee schedule.
- RecordTypeId; string; The unique name that identifies a record type.
- PrimaryKey: Finds a fee line decision model using the specified record type identifier, fee schedule ID, and fee schedule line.
-
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:- CurrencyCode; string; The default currency code from COM_AGENCY table.
- DftFeeItemId; string; The default fee item that is used if the fee item in the decision model does not match any fee items in COM_FEE_ITEM table.
- DmnModelName; string; The fee decision model name.
- DmnServiceName; string; The OIC REST service name for the deployed model.
- DmnSpaceId; string; 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; The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.
- DmnTag; string; The OIC tag is the version number for the deployed fee decision model.
- 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.
- FeeScheduleLine; integer; The line number for the current fee schedule.
- MapFeeAmount; string; The output resource name for fee amount to be stored.
- MapFeeItem; string; The output resource name for the fee item to be stored.
- MappingSource; string; The source transaction that requires field mapping to calculate fees.
- PayNow; string; Indicates whether the fee item is payable upon submission of the application or not. The default value is no.
- RecordTypeCode; string; A unique alphanumeric code or short name for the record type. This field should not contain any special characters or blank spaces.
- RecordTypeId; string; A unique name that identifies a record type.
- UseAmend; string; Indicates if the fee line is applicable for amendment. A value Y Indicates that the fee line is applicable.
- UseOrig; string; Indicates if the fee line is applicable for origination. A value Y Indicates that the fee line is applicable.
- UseRenew; string; Indicates if the fee line is applicable for renewal A value Y Indicates that the fee line is applicable.
-
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
-
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(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 : publicSectorFeeLineModels
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 : publicSectorFeeLineModels-item-response
Type:
Show Source
object
-
CurrencyCode: string
Read Only:
true
Maximum Length:3
The default currency code from COM_AGENCY table. -
DftFeeItemId: string
Read Only:
true
Maximum Length:30
The default fee item that is used if the fee item in the decision model does not match any fee items in COM_FEE_ITEM table. -
DmnModelName: string
Read Only:
true
Maximum Length:4000
The fee decision model name. -
DmnServiceName: string
Read Only:
true
Maximum Length:4000
The OIC REST service name for the deployed model. -
DmnSpaceId: string
Read Only:
true
Maximum Length:4000
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
Read Only:
true
Maximum Length:4000
The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field. -
DmnTag: string
Read Only:
true
Maximum Length:4000
The OIC tag is the version number for the deployed fee decision model. -
EffectiveEndDate: string
(date-time)
Read Only:
true
The end date of the fee schedule. -
EffectiveStartDate: string
(date-time)
Read Only:
true
The start date of the fee schedule. -
FeeScheduleId: string
Read Only:
true
Maximum Length:20
A unique name that identifies a fee schedule. -
FeeScheduleLine: integer
(int64)
Read Only:
true
The line number for the current fee schedule. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MapFeeAmount: string
Read Only:
true
Maximum Length:50
The output resource name for fee amount to be stored. -
MapFeeItem: string
Read Only:
true
Maximum Length:50
The output resource name for the fee item to be stored. -
MappingSource: string
Read Only:
true
Maximum Length:10
The source transaction that requires field mapping to calculate fees. -
PayNow: string
Read Only:
true
Maximum Length:1
Indicates whether the fee item is payable upon submission of the application or not. The default value is no. -
RecordTypeCode: string
Read Only:
true
Maximum Length:20
A unique alphanumeric code or short name for the record type. This field should not contain any special characters or blank spaces. -
RecordTypeId: string
Read Only:
true
Maximum Length:30
A unique name that identifies a record type. -
UseAmend: string
Read Only:
true
Maximum Length:1
Indicates if the fee line is applicable for amendment. A value Y Indicates that the fee line is applicable. -
UseOrig: string
Read Only:
true
Maximum Length:1
Indicates if the fee line is applicable for origination. A value Y Indicates that the fee line is applicable. -
UseRenew: string
Read Only:
true
Maximum Length:1
Indicates if the fee line is applicable for renewal A value Y Indicates that the fee line is applicable.
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.