Jump to

• Request
• Response

Create a set of fee lines

post

/fscmRestApi/resources/11.13.18.05/publicSectorFeeLines

Create a set of fee lines

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorFeeLines-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The identifier for the public sector agency to which this fee schedule belongs.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the fee line.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the fee line was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The default currency code from the COM_AGENCY table. For now, this field is display-only.
• DmnModelName(optional): string
  Title: Model Name

  Maximum Length: 1000

  The fee decision model name.
• DmnServiceName(optional): string
  Title: Service Name

  Maximum Length: 1000

  The OIC REST service name for the deployed model.
• DmnSpaceId(optional): 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(optional): string
  Title: Space Name

  Maximum Length: 1000

  The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.
• DmnTag(optional): string
  Title: Version

  Maximum Length: 1000

  The OIC tag is the version number for the deployed fee decision model.
• EffectiveEndDate(optional): string(date)
  Title: Effective End Date

  The end date of the fee schedule.
• EffectiveStartDate(optional): string(date)
  Title: Effective Start Date

  The start date of the fee schedule.
• FeeScheduleId(optional): string
  Title: Fee Schedule

  Maximum Length: 20

  A unique name that identifies a fee schedule.
• FeeScheduleLine(optional): integer(int64)
  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(optional): string(date-time)
  Title: Last Updated Date

  The date when the fee line was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the fee line.
• links(optional): array Items
  Title: Items

  Link Relations
• MapFeeAmount(optional): string
  Title: Map Fee Amount

  Maximum Length: 50

  The output resource name for fee amount to be stored.
• MapFeeItem(optional): string
  Title: Map Fee Item

  Maximum Length: 50

  The output resource name for the fee item to be stored.
• MapFeeReference(optional): string
  Title: Map Fee Reference

  Maximum Length: 50

  The identifier of the map fee reference for the decision model.
• MappingSource(optional): string
  Title: Mapping Source

  Maximum Length: 10

  Indicates the fee mapping source.
• PayNow(optional): 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(optional): string
  Maximum Length: 1

  Indicates whether this fee line is used for amended fees. This field is for future use. No default value.
• UseOrig(optional): string
  Maximum Length: 1

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorFeeLines-item

Type: object

Show Source

• AgencyId(optional): integer(int64)
  Title: Agency ID

  The identifier for the public sector agency to which this fee schedule belongs.
• CreatedBy(optional): string
  Title: Created By

  Maximum Length: 64

  The user who created the fee line.
• CreationDate(optional): string(date-time)
  Title: Creation Date

  The date when the fee line was created.
• CurrencyCode(optional): string
  Title: Currency

  Maximum Length: 3

  The default currency code from the COM_AGENCY table. For now, this field is display-only.
• DmnModelName(optional): string
  Title: Model Name

  Maximum Length: 1000

  The fee decision model name.
• DmnServiceName(optional): string
  Title: Service Name

  Maximum Length: 1000

  The OIC REST service name for the deployed model.
• DmnSpaceId(optional): 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(optional): string
  Title: Space Name

  Maximum Length: 1000

  The user-friendly OIC space name. This field relates to the DMN_SPACE_ID field.
• DmnTag(optional): string
  Title: Version

  Maximum Length: 1000

  The OIC tag is the version number for the deployed fee decision model.
• EffectiveEndDate(optional): string(date)
  Title: Effective End Date

  The end date of the fee schedule.
• EffectiveStartDate(optional): string(date)
  Title: Effective Start Date

  The start date of the fee schedule.
• FeeScheduleId(optional): string
  Title: Fee Schedule

  Maximum Length: 20

  A unique name that identifies a fee schedule.
• FeeScheduleLine(optional): integer(int64)
  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(optional): string(date-time)
  Title: Last Updated Date

  The date when the fee line was last updated.
• LastUpdatedBy(optional): string
  Title: Last Updated By

  Maximum Length: 64

  The user who last updated the fee line.
• links(optional): array Items
  Title: Items

  Link Relations
• MapFeeAmount(optional): string
  Title: Map Fee Amount

  Maximum Length: 50

  The output resource name for fee amount to be stored.
• MapFeeItem(optional): string
  Title: Map Fee Item

  Maximum Length: 50

  The output resource name for the fee item to be stored.
• MapFeeReference(optional): string
  Title: Map Fee Reference

  Maximum Length: 50

  The identifier of the map fee reference for the decision model.
• MappingSource(optional): string
  Title: Mapping Source

  Maximum Length: 10

  Indicates the fee mapping source.
• PayNow(optional): 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(optional): string
  Maximum Length: 1

  Indicates whether this fee line is used for amended fees. This field is for future use. No default value.
• UseOrig(optional): string
  Maximum Length: 1

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

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "title":"Items",
    "description":"Link Relations",
    "type":"array",
    "items":{
        "$ref":"#/definitions/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "href":{
            "title":"hyperlink reference",
            "description":"The URI to the related resource.",
            "type":"string"
        },
        "rel":{
            "title":"relation",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "type":"string"
        }
    }
}

Back to Top