Jump to

• Request
• Response

Get a fee line decision model

get

/fscmRestApi/resources/11.13.18.05/publicSectorFeeLineModels/{publicSectorFeeLineModelsUniqID}

Request

Path Parameters

• publicSectorFeeLineModelsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- RecordTypeId, FeeScheduleId, FeeScheduleLine, EffectiveStartDate and EffectiveEndDate ---for the Fee Line Models resource and used to uniquely identify an instance of Fee Line Models. The client should not generate the hash key value. Instead, the client should query on the Fee Line Models collection resource with a filter on the primary key values in order to navigate to a specific instance of Fee Line Models.
  
  For example: publicSectorFeeLineModels?q=RecordTypeId=<value1>;FeeScheduleId=<value2>;FeeScheduleLine=<value3>;EffectiveStartDate=<value4>;EffectiveEndDate=<value5>

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.

Back to Top

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.

Body ()

Root Schema : publicSectorFeeLineModels-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "EffectiveEndDate":{
            "type":"string",
            "description":"The end date of the fee schedule.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DmnServiceName":{
            "maxLength":"4000",
            "type":"string",
            "description":"The OIC REST service name for the deployed model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DmnTag":{
            "maxLength":"4000",
            "type":"string",
            "description":"The OIC tag is the version number for the deployed fee decision model.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "UseOrig":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the fee line is applicable for origination. A value Y Indicates that the fee line is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DmnSpaceId":{
            "maxLength":"4000",
            "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,
            "readOnly":true,
            "x-queryable":true
        },
        "FeeScheduleLine":{
            "type":"integer",
            "description":"The line number for the current fee schedule.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"20"
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "maxLength":"3",
            "type":"string",
            "description":"The default currency code from COM_AGENCY table.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"A unique alphanumeric code or short name for the record type. This field should not contain any special characters or blank spaces.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MapFeeItem":{
            "maxLength":"50",
            "type":"string",
            "description":"The output resource name for the fee item to be stored.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"A unique name that identifies a record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseAmend":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the fee line is applicable for amendment. A value Y Indicates that the fee line is applicable.",
            "nullable":true,
            "readOnly":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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DmnModelName":{
            "maxLength":"4000",
            "type":"string",
            "description":"The fee decision model name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MapFeeAmount":{
            "maxLength":"50",
            "type":"string",
            "description":"The output resource name for fee amount to be stored.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MappingSource":{
            "maxLength":"10",
            "type":"string",
            "description":"The source transaction that requires field mapping to calculate fees.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "UseRenew":{
            "maxLength":"1",
            "type":"string",
            "description":"Indicates if the fee line is applicable for renewal A value Y Indicates that the fee line is applicable.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PayNow":{
            "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":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EffectiveStartDate":{
            "type":"string",
            "description":"The start date of the fee schedule.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DftFeeItemId":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DmnSpaceName":{
            "maxLength":"4000",
            "type":"string",
            "description":"The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.",
            "nullable":true,
            "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."
        }
    }
}

Back to Top