Jump to

• Request
• Response

Create a set of expiration rules in an expiration group

post

/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules

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 : publicSectorExpirationRules-item

Type: object

Show Source

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

  The unique identifier of the public sector agency.
• AteDuration(optional): integer(int64)
  Title: About to Expire

  The value that indicates the About to Expire duration.
• AteDurUom(optional): string
  Title: About to Expire Duration UOM

  Maximum Length: 5

  The unit of measure for the About to Expire duration.
• CommAteFlag(optional): string
  Title: About to Expire

  Maximum Length: 1

  Indicates that the communication is enabled for About to Expire status.
• CommAteFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for the About to Expire status.
• CommAteFrequency(optional): string
  Title: Recurrence

  Maximum Length: 7

  Indicates the number of comunication recurrences for the About to Expire status.
• CommAteMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for About to Expire status.
• CommDelinqFlag(optional): string
  Title: Delinquent

  Maximum Length: 1

  Indicates that the communication is enabled for Delinquent status.
• CommDelinqFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for the Delinquent status.
• CommDelinqFrequency(optional): string
  Title: Recurrence

  Maximum Length: 5

  Indicates the number of comunication recurrences for the Delinquent status.
• CommDelinqMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for Delinquent status.
• CommExpireFlag(optional): string
  Title: Expired

  Maximum Length: 1

  Indicates that the communication is enabled for Expired status.
• CommExpireFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for Expired status.
• CommExpireFrequency(optional): string
  Title: Recurrence

  Maximum Length: 7

  Indicates the number of communication recurrences for Expired status.
• CommExpireMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the maximum number of communication recurrences for Expired status.
• EffectiveEndDate(optional): string(date)
  Title: Effective End Date

  The end date for the expiration rule.
• EffectiveStartDate(optional): string(date)
  Title: Effective Start Date

  The start date for the expiration rule.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates that the expiration rule is available for use. The default value is true.
• ExpIntervalDuration(optional): integer(int32)
  Title: Expiration Interval

  Indicates the expiration interval duration for the business license expiration rule.
• ExpIntervalDurationUom(optional): string
  Title: Expiration Interval Unit of Measure

  Maximum Length: 10

  The unit of measure for expiration interval duration.
• ExpirationBasis(optional): string
  Maximum Length: 10

  The unique criteria derived from the record status to apply the expiration rule.
• ExpirationDuration(optional): integer(int64)
  Title: Expiration Duration

  The value of the expiration duration.
• ExpirationDurUom(optional): string
  Title: Expiration Duration UOM

  Maximum Length: 5

  The unit of measure for the expiration duration.
• ExpirationGroupId(optional): string
  Title: Expiration Group ID

  Maximum Length: 50

  The unique identifier of the expiration rule group.
• GracePeriod(optional): integer(int64)
  Title: Grace Period

  The value of the grace period.
• GracePeriodUom(optional): string
  Title: Grace Period UOM

  Maximum Length: 5

  The unit of measure for the grace period.
• InsAutoExtendFlag(optional): string
  Title: Auto-Extend Permit Expiration

  Maximum Length: 1

  Indicates that the auto extend is enabled.
• InsCommAutoExpireFlag(optional): string
  Title: Automatic Expiration

  Maximum Length: 1

  Indicates that the auto expire option based on the inspection commencement is enabled.
• InsCommencementDateOption(optional): string
  Title: Date Option

  Maximum Length: 30

  Indicate the date options for the inspection commencement.
• InsCommencementDuration(optional): integer(int64)
  Title: Duration

  Indicates the inspection commencement duration for the Permit Expire basis.
• InsCommencementDurationUom(optional): string
  Title: Unit of Measure

  Maximum Length: 5

  The unit of measure for the inspection commencement duration.
• InsDurationExtend(optional): integer(int64)
  Title: Extension Duration

  The auto extend duration value.
• InsDurationExtendUom(optional): string
  Title: Extend Inspection Duration UOM

  Maximum Length: 5

  The unit of measure for auto extend duration.
• InsResultOption(optional): string
  Title: Result

  Maximum Length: 10

  The inspection result for which expiration rule is mapped.
• links(optional): array Items
  Title: Items

  Link Relations
• NumExtensions(optional): integer(int32)
  Title: Number of Extensions

  The number of extensions allowed for the expiration rule.
• RuleSequence(optional): integer(int64)
  Title: Expiration Basis

  The sequence of the expiration rule.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "AteDurUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the About to Expire duration.",
            "title":"About to Expire Duration UOM"
        },
        "AteDuration":{
            "format":"int64",
            "type":"integer",
            "description":"The value that indicates the About to Expire duration.",
            "title":"About to Expire"
        },
        "CommAteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for About to Expire status.",
            "title":"About to Expire"
        },
        "CommAteFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for the About to Expire status.",
            "title":"Every"
        },
        "CommAteFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates the number of comunication recurrences for the About to Expire status.",
            "title":"Recurrence"
        },
        "CommAteMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for About to Expire status.",
            "title":"Maximum Recurrences"
        },
        "CommDelinqFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for Delinquent status.",
            "title":"Delinquent"
        },
        "CommDelinqFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for the Delinquent status.",
            "title":"Every"
        },
        "CommDelinqFrequency":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the number of comunication recurrences for the Delinquent status.",
            "title":"Recurrence"
        },
        "CommDelinqMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for Delinquent status.",
            "title":"Maximum Recurrences"
        },
        "CommExpireFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for Expired status.",
            "title":"Expired"
        },
        "CommExpireFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for Expired status.",
            "title":"Every"
        },
        "CommExpireFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates the number of communication recurrences for Expired status.",
            "title":"Recurrence"
        },
        "CommExpireMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the maximum number of communication recurrences for Expired status.",
            "title":"Maximum Recurrences"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date for the expiration rule.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date for the expiration rule.",
            "title":"Effective Start Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the expiration rule is available for use. The default value is true.",
            "title":"Enabled"
        },
        "ExpIntervalDuration":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the expiration interval duration for the business license expiration rule.",
            "title":"Expiration Interval"
        },
        "ExpIntervalDurationUom":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for expiration interval duration.",
            "title":"Expiration Interval Unit of Measure"
        },
        "ExpirationBasis":{
            "maxLength":10,
            "type":"string",
            "description":"The unique criteria derived from the record status to apply the expiration rule."
        },
        "ExpirationDurUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the expiration duration.",
            "title":"Expiration Duration UOM"
        },
        "ExpirationDuration":{
            "format":"int64",
            "type":"integer",
            "description":"The value of the expiration duration.",
            "title":"Expiration Duration"
        },
        "ExpirationGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the expiration rule group.",
            "title":"Expiration Group ID"
        },
        "GracePeriod":{
            "format":"int64",
            "type":"integer",
            "description":"The value of the grace period.",
            "title":"Grace Period"
        },
        "GracePeriodUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the grace period.",
            "title":"Grace Period UOM"
        },
        "InsAutoExtendFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the auto extend is enabled.",
            "title":"Auto-Extend Permit Expiration"
        },
        "InsCommAutoExpireFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the auto expire option based on the inspection commencement is enabled.",
            "title":"Automatic Expiration"
        },
        "InsCommencementDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicate the date options for the inspection commencement.",
            "title":"Date Option"
        },
        "InsCommencementDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the inspection commencement duration for the Permit Expire basis.",
            "title":"Duration"
        },
        "InsCommencementDurationUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the inspection commencement duration.",
            "title":"Unit of Measure"
        },
        "InsDurationExtend":{
            "format":"int64",
            "type":"integer",
            "description":"The auto extend duration value.",
            "title":"Extension Duration"
        },
        "InsDurationExtendUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for auto extend duration.",
            "title":"Extend Inspection Duration UOM"
        },
        "InsResultOption":{
            "maxLength":10,
            "type":"string",
            "description":"The inspection result for which expiration rule is mapped.",
            "title":"Result"
        },
        "NumExtensions":{
            "format":"int32",
            "type":"integer",
            "description":"The number of extensions allowed for the expiration rule.",
            "title":"Number of Extensions"
        },
        "RuleSequence":{
            "format":"int64",
            "type":"integer",
            "description":"The sequence of the expiration rule.",
            "title":"Expiration Basis"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorExpirationRules-item

Type: object

Show Source

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

  The unique identifier of the public sector agency.
• AteDuration(optional): integer(int64)
  Title: About to Expire

  The value that indicates the About to Expire duration.
• AteDurUom(optional): string
  Title: About to Expire Duration UOM

  Maximum Length: 5

  The unit of measure for the About to Expire duration.
• CommAteFlag(optional): string
  Title: About to Expire

  Maximum Length: 1

  Indicates that the communication is enabled for About to Expire status.
• CommAteFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for the About to Expire status.
• CommAteFrequency(optional): string
  Title: Recurrence

  Maximum Length: 7

  Indicates the number of comunication recurrences for the About to Expire status.
• CommAteMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for About to Expire status.
• CommDelinqFlag(optional): string
  Title: Delinquent

  Maximum Length: 1

  Indicates that the communication is enabled for Delinquent status.
• CommDelinqFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for the Delinquent status.
• CommDelinqFrequency(optional): string
  Title: Recurrence

  Maximum Length: 5

  Indicates the number of comunication recurrences for the Delinquent status.
• CommDelinqMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for Delinquent status.
• CommExpireFlag(optional): string
  Title: Expired

  Maximum Length: 1

  Indicates that the communication is enabled for Expired status.
• CommExpireFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for Expired status.
• CommExpireFrequency(optional): string
  Title: Recurrence

  Maximum Length: 7

  Indicates the number of communication recurrences for Expired status.
• CommExpireMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the maximum number of communication recurrences for Expired status.
• EffectiveEndDate(optional): string(date)
  Title: Effective End Date

  The end date for the expiration rule.
• EffectiveStartDate(optional): string(date)
  Title: Effective Start Date

  The start date for the expiration rule.
• EnabledFlag(optional): string
  Title: Enabled

  Maximum Length: 1

  Indicates that the expiration rule is available for use. The default value is true.
• ExpIntervalDuration(optional): integer(int32)
  Title: Expiration Interval

  Indicates the expiration interval duration for the business license expiration rule.
• ExpIntervalDurationUom(optional): string
  Title: Expiration Interval Unit of Measure

  Maximum Length: 10

  The unit of measure for expiration interval duration.
• ExpirationBasis(optional): string
  Maximum Length: 10

  The unique criteria derived from the record status to apply the expiration rule.
• ExpirationDuration(optional): integer(int64)
  Title: Expiration Duration

  The value of the expiration duration.
• ExpirationDurUom(optional): string
  Title: Expiration Duration UOM

  Maximum Length: 5

  The unit of measure for the expiration duration.
• ExpirationGroupId(optional): string
  Title: Expiration Group ID

  Maximum Length: 50

  The unique identifier of the expiration rule group.
• GracePeriod(optional): integer(int64)
  Title: Grace Period

  The value of the grace period.
• GracePeriodUom(optional): string
  Title: Grace Period UOM

  Maximum Length: 5

  The unit of measure for the grace period.
• InsAutoExtendFlag(optional): string
  Title: Auto-Extend Permit Expiration

  Maximum Length: 1

  Indicates that the auto extend is enabled.
• InsCommAutoExpireFlag(optional): string
  Title: Automatic Expiration

  Maximum Length: 1

  Indicates that the auto expire option based on the inspection commencement is enabled.
• InsCommencementDateOption(optional): string
  Title: Date Option

  Maximum Length: 30

  Indicate the date options for the inspection commencement.
• InsCommencementDuration(optional): integer(int64)
  Title: Duration

  Indicates the inspection commencement duration for the Permit Expire basis.
• InsCommencementDurationUom(optional): string
  Title: Unit of Measure

  Maximum Length: 5

  The unit of measure for the inspection commencement duration.
• InsDurationExtend(optional): integer(int64)
  Title: Extension Duration

  The auto extend duration value.
• InsDurationExtendUom(optional): string
  Title: Extend Inspection Duration UOM

  Maximum Length: 5

  The unit of measure for auto extend duration.
• InsResultOption(optional): string
  Title: Result

  Maximum Length: 10

  The inspection result for which expiration rule is mapped.
• links(optional): array Items
  Title: Items

  Link Relations
• NumExtensions(optional): integer(int32)
  Title: Number of Extensions

  The number of extensions allowed for the expiration rule.
• RuleSequence(optional): integer(int64)
  Title: Expiration Basis

  The sequence of the expiration rule.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "AteDurUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the About to Expire duration.",
            "title":"About to Expire Duration UOM"
        },
        "AteDuration":{
            "format":"int64",
            "type":"integer",
            "description":"The value that indicates the About to Expire duration.",
            "title":"About to Expire"
        },
        "CommAteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for About to Expire status.",
            "title":"About to Expire"
        },
        "CommAteFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for the About to Expire status.",
            "title":"Every"
        },
        "CommAteFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates the number of comunication recurrences for the About to Expire status.",
            "title":"Recurrence"
        },
        "CommAteMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for About to Expire status.",
            "title":"Maximum Recurrences"
        },
        "CommDelinqFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for Delinquent status.",
            "title":"Delinquent"
        },
        "CommDelinqFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for the Delinquent status.",
            "title":"Every"
        },
        "CommDelinqFrequency":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the number of comunication recurrences for the Delinquent status.",
            "title":"Recurrence"
        },
        "CommDelinqMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for Delinquent status.",
            "title":"Maximum Recurrences"
        },
        "CommExpireFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for Expired status.",
            "title":"Expired"
        },
        "CommExpireFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for Expired status.",
            "title":"Every"
        },
        "CommExpireFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates the number of communication recurrences for Expired status.",
            "title":"Recurrence"
        },
        "CommExpireMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the maximum number of communication recurrences for Expired status.",
            "title":"Maximum Recurrences"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date for the expiration rule.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date for the expiration rule.",
            "title":"Effective Start Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the expiration rule is available for use. The default value is true.",
            "title":"Enabled"
        },
        "ExpIntervalDuration":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the expiration interval duration for the business license expiration rule.",
            "title":"Expiration Interval"
        },
        "ExpIntervalDurationUom":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for expiration interval duration.",
            "title":"Expiration Interval Unit of Measure"
        },
        "ExpirationBasis":{
            "maxLength":10,
            "type":"string",
            "description":"The unique criteria derived from the record status to apply the expiration rule."
        },
        "ExpirationDurUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the expiration duration.",
            "title":"Expiration Duration UOM"
        },
        "ExpirationDuration":{
            "format":"int64",
            "type":"integer",
            "description":"The value of the expiration duration.",
            "title":"Expiration Duration"
        },
        "ExpirationGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the expiration rule group.",
            "title":"Expiration Group ID"
        },
        "GracePeriod":{
            "format":"int64",
            "type":"integer",
            "description":"The value of the grace period.",
            "title":"Grace Period"
        },
        "GracePeriodUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the grace period.",
            "title":"Grace Period UOM"
        },
        "InsAutoExtendFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the auto extend is enabled.",
            "title":"Auto-Extend Permit Expiration"
        },
        "InsCommAutoExpireFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the auto expire option based on the inspection commencement is enabled.",
            "title":"Automatic Expiration"
        },
        "InsCommencementDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicate the date options for the inspection commencement.",
            "title":"Date Option"
        },
        "InsCommencementDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the inspection commencement duration for the Permit Expire basis.",
            "title":"Duration"
        },
        "InsCommencementDurationUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the inspection commencement duration.",
            "title":"Unit of Measure"
        },
        "InsDurationExtend":{
            "format":"int64",
            "type":"integer",
            "description":"The auto extend duration value.",
            "title":"Extension Duration"
        },
        "InsDurationExtendUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for auto extend duration.",
            "title":"Extend Inspection Duration UOM"
        },
        "InsResultOption":{
            "maxLength":10,
            "type":"string",
            "description":"The inspection result for which expiration rule is mapped.",
            "title":"Result"
        },
        "NumExtensions":{
            "format":"int32",
            "type":"integer",
            "description":"The number of extensions allowed for the expiration rule.",
            "title":"Number of Extensions"
        },
        "RuleSequence":{
            "format":"int64",
            "type":"integer",
            "description":"The sequence of the expiration rule.",
            "title":"Expiration Basis"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top