Jump to

• Request
• Response

Create a set of fee lines

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines

Request

Header Parameters

• Metadata-Context: string
  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: string
  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: string
  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

Request Body - application/json ()

Root Schema : schema

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

  Indicates the fee mapping source.
• 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. No default value.
• UseExpiration: string
  Maximum Length: 1

  Indicates that the fee should be calculated while expiration processing.
• UseOrig: string
  Maximum Length: 1

  Indicates whether this fee line is used for the original fees. The default value is Y.
• UseRenew: string
  Maximum Length: 1

  Indicates whether this fee line is used for renewal fees. This field is for future use. No default value.

{
    "type":"object",
    "properties":{
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency to which this fee schedule belongs.",
            "nullable":false,
            "default":1
        },
        "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"
            }
        },
        "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"
            }
        },
        "UseExpiration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the fee should be calculated while expiration processing.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "UseOrig":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this fee line is used for the original fees. The default value is Y.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"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"
            }
        },
        "MapFeeReference":{
            "title":"Map Fee Reference",
            "maxLength":50,
            "type":"string",
            "description":"The identifier of the map fee reference for the decision model.",
            "nullable":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"
            }
        },
        "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
        },
        "MapFeeItem":{
            "title":"Map Fee Item",
            "maxLength":50,
            "type":"string",
            "description":"The output resource name for the fee item to be stored.",
            "nullable":false
        },
        "UseAmend":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this fee line is used for amended fees. This field is for future use. No default value.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "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"
            }
        },
        "DmnModelName":{
            "title":"Model Name",
            "maxLength":1000,
            "type":"string",
            "description":"The fee decision model name.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "UseRenew":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether this fee line is used for renewal fees. This field is for future use. No default value.",
            "nullable":true,
            "x-hints":{
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            }
        },
        "MappingSource":{
            "title":"Mapping Source",
            "maxLength":10,
            "type":"string",
            "description":"Indicates the fee mapping source.",
            "nullable":false
        },
        "MapFeeAmount":{
            "title":"Map Fee Amount",
            "maxLength":50,
            "type":"string",
            "description":"The output resource name for fee amount to be stored.",
            "nullable":false
        },
        "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"
            }
        },
        "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"
            }
        },
        "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"
            }
        }
    }
}

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

  Indicates the fee mapping source.
• 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. No default value.
• UseExpiration: string
  Maximum Length: 1

  Indicates that the fee should be calculated while expiration processing.
• UseOrig: string
  Maximum Length: 1

  Indicates whether this fee line is used for the original fees. The default value is Y.
• UseRenew: string
  Maximum Length: 1

  Indicates whether this fee line is used for renewal fees. This field is for future use. 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
        },
        "UseExpiration":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the fee should be calculated while expiration processing.",
            "nullable":true,
            "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. 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. 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
        },
        "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 Y.",
            "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":"Indicates the fee mapping source.",
            "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 : 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