Create an expiration group
post
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorExpirationGroups-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the public sector agency. -
Classification(optional):
string
Title:
ClassificationMaximum Length:3The classification of the record type. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the related expiration rule. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the related expiration rule was last updated. -
Description(optional):
string
Title:
DescriptionMaximum Length:1000The long description of the expiration group. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date for the expiration group. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date for the expiration group. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates whether the expiration group is available for use. The default value is true. -
ExpirationGroup(optional):
string
Title:
Expiration Group NameMaximum Length:150The short description of the expiration group. -
ExpirationGroupId(optional):
string
Title:
Expiration Group IDMaximum Length:50The unique identifier of the expiration group. -
ExpirationRuleD(optional):
array Expiration Rules
Title:
Expiration RulesThe expiration rule resource is used to create, update, or remove expiration rules from an expiration group. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the related expiration rule was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the related expiration rule. -
links(optional):
array Items
Title:
ItemsLink Relations -
Subclassification(optional):
string
Title:
SubclassificationMaximum Length:10The subclassification of the transaction type, which indicates that the pre-application process is included.
Nested Schema : Expiration Rules
Type:
arrayTitle:
Expiration RulesThe expiration rule resource is used to create, update, or remove expiration rules from an expiration group.
Show Source
Nested Schema : publicSectorExpirationGroups-ExpirationRuleD-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the public sector agency. -
AteDuration(optional):
integer(int64)
Title:
About to ExpireThe value that indicates the About to Expire duration. -
AteDurUom(optional):
string
Title:
About to Expire Duration UOMMaximum Length:5The unit of measure for the About to Expire duration. -
CommAteFlag(optional):
string
Title:
About to ExpireMaximum Length:1Indicates that the communication is enabled for About to Expire status. -
CommAteFreqDuration(optional):
integer(int64)
Title:
EveryIndicates the comunication recurrences duration for the About to Expire status. -
CommAteFrequency(optional):
string
Title:
RecurrenceMaximum Length:7Indicates the number of comunication recurrences for the About to Expire status. -
CommAteMaxFreq(optional):
integer(int32)
Title:
Maximum RecurrencesIndicates the number of maximum communication recurrences for About to Expire status. -
CommDelinqFlag(optional):
string
Title:
DelinquentMaximum Length:1Indicates that the communication is enabled for Delinquent status. -
CommDelinqFreqDuration(optional):
integer(int64)
Title:
EveryIndicates the comunication recurrences duration for the Delinquent status. -
CommDelinqFrequency(optional):
string
Title:
RecurrenceMaximum Length:5Indicates the number of comunication recurrences for the Delinquent status. -
CommDelinqMaxFreq(optional):
integer(int32)
Title:
Maximum RecurrencesIndicates the number of maximum communication recurrences for Delinquent status. -
CommExpireFlag(optional):
string
Title:
ExpiredMaximum Length:1Indicates that the communication is enabled for Expired status. -
CommExpireFreqDuration(optional):
integer(int64)
Title:
EveryIndicates the comunication recurrences duration for Expired status. -
CommExpireFrequency(optional):
string
Title:
RecurrenceMaximum Length:7Indicates the number of communication recurrences for Expired status. -
CommExpireMaxFreq(optional):
integer(int32)
Title:
Maximum RecurrencesIndicates the maximum number of communication recurrences for Expired status. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date for the expiration rule. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date for the expiration rule. -
EnabledFlag(optional):
string
Title:
EnabledMaximum Length:1Indicates whether the expiration rule is available for use. The default value is true. -
ExpIntervalDuration(optional):
integer(int32)
Title:
Expiration IntervalIndicates the expiration interval duration for the business license expiration rule. -
ExpIntervalDurationUom(optional):
string
Title:
Expiration Interval Unit of MeasureMaximum Length:10The unit of measure for expiration interval duration. -
ExpirationBasis(optional):
string
Maximum Length:
10The unique criteria derived from the record status to apply the expiration rule. -
ExpirationDuration(optional):
integer(int64)
Title:
Expiration DurationThe value that indicates the expiration duration. -
ExpirationDurUom(optional):
string
Title:
Expiration Duration UOMMaximum Length:5The unit of measure for expiration duration. -
ExpirationGroupId(optional):
string
Title:
Expiration Group IDMaximum Length:50The unique identifier of the expiration group. -
GracePeriod(optional):
integer(int64)
Title:
Grace PeriodThe value that indicates the grace period. -
GracePeriodUom(optional):
string
Title:
Grace Period UOMMaximum Length:5The unit of measure for the grace period. -
InsAutoExtendFlag(optional):
string
Title:
Auto-Extend Permit ExpirationMaximum Length:1Indicates that the auto extend is enabled. -
InsCommAutoExpireFlag(optional):
string
Title:
Automatic ExpirationMaximum Length:1Indicates that the auto expire option based on the inspection commencement is enabled. -
InsCommencementDateOption(optional):
string
Title:
Date OptionMaximum Length:30Indicate the date options for the inspection commencement. -
InsCommencementDuration(optional):
integer(int64)
Title:
DurationIndicates the inspection commencement duration for the Permit Expire basis. -
InsCommencementDurationUom(optional):
string
Title:
Unit of MeasureMaximum Length:5The unit of measure for the inspection commencement duration. -
InsDurationExtend(optional):
integer(int64)
Title:
Extension DurationThe auto extend duration value. -
InsDurationExtendUom(optional):
string
Title:
Extend Inspection Duration UOMMaximum Length:5The unit of measure for auto extend duration. -
InsResultOption(optional):
string
Title:
ResultMaximum Length:10The inspection result for which expiration rule is mapped. -
links(optional):
array Items
Title:
ItemsLink Relations -
NumExtensions(optional):
integer(int32)
Title:
Number of ExtensionsThe number of extensions allowed for the expiration rule. -
RuleSequence(optional):
integer(int64)
Title:
Expiration BasisThe sequence value of the expiration rule.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorExpirationGroups-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the public sector agency. -
Classification(optional):
string
Title:
ClassificationMaximum Length:3The classification of the record type. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The name of the user who created the related expiration rule. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the related expiration rule was last updated. -
Description(optional):
string
Title:
DescriptionMaximum Length:1000The long description of the expiration group. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date for the expiration group. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date for the expiration group. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates whether the expiration group is available for use. The default value is true. -
ExpirationGroup(optional):
string
Title:
Expiration Group NameMaximum Length:150The short description of the expiration group. -
ExpirationGroupId(optional):
string
Title:
Expiration Group IDMaximum Length:50The unique identifier of the expiration group. -
ExpirationRuleD(optional):
array Expiration Rules
Title:
Expiration RulesThe expiration rule resource is used to create, update, or remove expiration rules from an expiration group. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the related expiration rule was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The name of the user who last updated the related expiration rule. -
links(optional):
array Items
Title:
ItemsLink Relations -
Subclassification(optional):
string
Title:
SubclassificationMaximum Length:10The subclassification of the transaction type, which indicates that the pre-application process is included.
Nested Schema : Expiration Rules
Type:
arrayTitle:
Expiration RulesThe expiration rule resource is used to create, update, or remove expiration rules from an expiration group.
Show Source
Nested Schema : publicSectorExpirationGroups-ExpirationRuleD-item
Type:
Show Source
object-
AgencyId(optional):
integer(int32)
Title:
Agency IDThe unique identifier of the public sector agency. -
AteDuration(optional):
integer(int64)
Title:
About to ExpireThe value that indicates the About to Expire duration. -
AteDurUom(optional):
string
Title:
About to Expire Duration UOMMaximum Length:5The unit of measure for the About to Expire duration. -
CommAteFlag(optional):
string
Title:
About to ExpireMaximum Length:1Indicates that the communication is enabled for About to Expire status. -
CommAteFreqDuration(optional):
integer(int64)
Title:
EveryIndicates the comunication recurrences duration for the About to Expire status. -
CommAteFrequency(optional):
string
Title:
RecurrenceMaximum Length:7Indicates the number of comunication recurrences for the About to Expire status. -
CommAteMaxFreq(optional):
integer(int32)
Title:
Maximum RecurrencesIndicates the number of maximum communication recurrences for About to Expire status. -
CommDelinqFlag(optional):
string
Title:
DelinquentMaximum Length:1Indicates that the communication is enabled for Delinquent status. -
CommDelinqFreqDuration(optional):
integer(int64)
Title:
EveryIndicates the comunication recurrences duration for the Delinquent status. -
CommDelinqFrequency(optional):
string
Title:
RecurrenceMaximum Length:5Indicates the number of comunication recurrences for the Delinquent status. -
CommDelinqMaxFreq(optional):
integer(int32)
Title:
Maximum RecurrencesIndicates the number of maximum communication recurrences for Delinquent status. -
CommExpireFlag(optional):
string
Title:
ExpiredMaximum Length:1Indicates that the communication is enabled for Expired status. -
CommExpireFreqDuration(optional):
integer(int64)
Title:
EveryIndicates the comunication recurrences duration for Expired status. -
CommExpireFrequency(optional):
string
Title:
RecurrenceMaximum Length:7Indicates the number of communication recurrences for Expired status. -
CommExpireMaxFreq(optional):
integer(int32)
Title:
Maximum RecurrencesIndicates the maximum number of communication recurrences for Expired status. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End DateThe end date for the expiration rule. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start DateThe start date for the expiration rule. -
EnabledFlag(optional):
string
Title:
EnabledMaximum Length:1Indicates whether the expiration rule is available for use. The default value is true. -
ExpIntervalDuration(optional):
integer(int32)
Title:
Expiration IntervalIndicates the expiration interval duration for the business license expiration rule. -
ExpIntervalDurationUom(optional):
string
Title:
Expiration Interval Unit of MeasureMaximum Length:10The unit of measure for expiration interval duration. -
ExpirationBasis(optional):
string
Maximum Length:
10The unique criteria derived from the record status to apply the expiration rule. -
ExpirationDuration(optional):
integer(int64)
Title:
Expiration DurationThe value that indicates the expiration duration. -
ExpirationDurUom(optional):
string
Title:
Expiration Duration UOMMaximum Length:5The unit of measure for expiration duration. -
ExpirationGroupId(optional):
string
Title:
Expiration Group IDMaximum Length:50The unique identifier of the expiration group. -
GracePeriod(optional):
integer(int64)
Title:
Grace PeriodThe value that indicates the grace period. -
GracePeriodUom(optional):
string
Title:
Grace Period UOMMaximum Length:5The unit of measure for the grace period. -
InsAutoExtendFlag(optional):
string
Title:
Auto-Extend Permit ExpirationMaximum Length:1Indicates that the auto extend is enabled. -
InsCommAutoExpireFlag(optional):
string
Title:
Automatic ExpirationMaximum Length:1Indicates that the auto expire option based on the inspection commencement is enabled. -
InsCommencementDateOption(optional):
string
Title:
Date OptionMaximum Length:30Indicate the date options for the inspection commencement. -
InsCommencementDuration(optional):
integer(int64)
Title:
DurationIndicates the inspection commencement duration for the Permit Expire basis. -
InsCommencementDurationUom(optional):
string
Title:
Unit of MeasureMaximum Length:5The unit of measure for the inspection commencement duration. -
InsDurationExtend(optional):
integer(int64)
Title:
Extension DurationThe auto extend duration value. -
InsDurationExtendUom(optional):
string
Title:
Extend Inspection Duration UOMMaximum Length:5The unit of measure for auto extend duration. -
InsResultOption(optional):
string
Title:
ResultMaximum Length:10The inspection result for which expiration rule is mapped. -
links(optional):
array Items
Title:
ItemsLink Relations -
NumExtensions(optional):
integer(int32)
Title:
Number of ExtensionsThe number of extensions allowed for the expiration rule. -
RuleSequence(optional):
integer(int64)
Title:
Expiration BasisThe sequence value of the expiration rule.
Nested Schema : link
Type:
Show Source
object-
href(optional):
string
Title:
hyperlink referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.