REST API for Oracle Public Sector Permitting and Licensing

Get a fee line

get

/fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}

Request

Path Parameters

FeeLineUniqID(required): string

This is the hash key of the attributes which make up the composite key--- AgencyId, FeeScheduleId, EffectiveStartDate, EffectiveEndDate and FeeScheduleLine ---for the Fee Lines resource and used to uniquely identify an instance of Fee Lines. The client should not generate the hash key value. Instead, the client should query on the Fee Lines collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Lines.

For example: FeeLine?q=AgencyId=<value1>;FeeScheduleId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;FeeScheduleLine=<value5>
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>

Query Parameters

dependency: string

This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2

Format: <attr1>=<val1>,<attr2>=<value2>
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
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
onlyData: boolean

The resource item payload will be filtered in order to contain only data (no links section, for example).

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.

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-FeeLine-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the fee line was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this fee schedule belongs.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "DmnServiceName":{
            "title":"Service Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The OIC REST service name for the deployed model.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmnTag":{
            "title":"Version",
            "maxLength":"1000",
            "type":"string",
            "description":"The OIC tag is the version number for the deployed fee decision model.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "title":"Fee Items",
            "type":"integer",
            "description":"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.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"false",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency",
            "maxLength":"3",
            "type":"string",
            "description":"The default currency code from the COM_AGENCY table. For now, this field is display-only.",
            "nullable":false,
            "x-queryable":true
        },
        "MapFeeItem":{
            "title":"Map Fee Item",
            "maxLength":"50",
            "type":"string",
            "description":"The output resource name for the fee item to be stored.",
            "nullable":false,
            "x-queryable":true
        },
        "UseAmend":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this fee line is used for amended fees. This field is for future use. There is no default value.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "title":"Fee Schedule",
            "maxLength":"20",
            "type":"string",
            "description":"A unique name that identifies a fee schedule.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"true",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmnModelName":{
            "title":"Model Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The fee decision model name.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UseRenew":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this fee line is used for renewal fees. This field is for future use. There is no default value.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MapFeeAmount":{
            "title":"Map Fee Amount",
            "maxLength":"50",
            "type":"string",
            "description":"The output resource name for fee amount to be stored.",
            "nullable":false,
            "x-queryable":true
        },
        "FeeScheduleMapD":{
            "title":"Fee Schedule Map Data",
            "type":"array",
            "description":"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.",
            "items":{
                "$ref":"#/components/schemas/publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response"
            }
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the fee line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the fee line.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "title":"Effective End Date",
            "type":"string",
            "description":"The end date of the fee schedule.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"false",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UseOrig":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether this fee line is used for the original fees. The default value is yes.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmnSpaceId":{
            "title":"Space ID",
            "maxLength":"1000",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "MapFeeReference":{
            "title":"Map Fee Reference",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier of the map fee reference for the decision model.",
            "nullable":true,
            "x-queryable":true
        },
        "MappingSource":{
            "title":"Mapping Source",
            "maxLength":"10",
            "type":"string",
            "description":"The source transaction that requires field mapping to calculate fees.",
            "nullable":false,
            "x-queryable":true
        },
        "PayNow":{
            "title":"Pay Now",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the fee item is payable upon submission of the application or not. The default value is no.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "title":"Effective Start Date",
            "type":"string",
            "description":"The start date of the fee schedule.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_USER_KEY":"false",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmnSpaceName":{
            "title":"Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the fee line was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

Array of: object publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response

{
    "title":"Fee Schedule Map Data",
    "type":"array",
    "description":"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.",
    "items":{
        "$ref":"#/components/schemas/publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response"
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : publicSectorFeeSchedules-FeeLine-FeeScheduleMapD-item-response

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "MappingType":{
            "maxLength":"10",
            "type":"string",
            "description":"The identifier to distinguish between the IN and OUT mapping.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the source business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The date when the fee schedule map was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency to which this fee schedule map belongs.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date of the fee schedule map.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "type":"integer",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"The label for the DMN input field name.",
            "nullable":true,
            "x-queryable":true
        },
        "FieldNum":{
            "type":"integer",
            "description":"The sequence number for the field in the mapping table.",
            "nullable":false,
            "x-queryable":true
        },
        "TargetLabel":{
            "maxLength":"200",
            "type":"string",
            "description":"The label for the target field name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"The DMN input field name.",
            "nullable":true,
            "x-queryable":true
        },
        "TargetFieldname":{
            "maxLength":"50",
            "type":"string",
            "description":"This field name in the transaction table that contains the DMN input value.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceFieldtype":{
            "maxLength":"30",
            "type":"string",
            "description":"The data type of the DMN input field name.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "maxLength":"20",
            "type":"string",
            "description":"A unique name that identifies a fee schedule.",
            "nullable":false,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date of the fee schedule map.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TargetObjectname":{
            "maxLength":"200",
            "type":"string",
            "description":"The name of the target business object for an array.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the fee schedule map was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

changeIndicator: string

Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

FeeScheduleMapD

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorFeeSchedules/{publicSectorFeeSchedulesUniqID}/child/FeeLine/{FeeLineUniqID}/child/FeeScheduleMapD

Parameters:

FeeLineUniqID: $request.path.FeeLineUniqID
publicSectorFeeSchedulesUniqID: $request.path.publicSectorFeeSchedulesUniqID

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.