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 ID
The unique identifier of the public sector agency. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The classification of the record type. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the related expiration rule. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the related expiration rule was last updated. -
Description(optional):
string
Title:
Description
Maximum Length:1000
The long description of the expiration group. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End Date
The end date for the expiration group. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start Date
The start date for the expiration group. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the expiration group is available for use. The default value is true. -
ExpirationGroup(optional):
string
Title:
Expiration Group Name
Maximum Length:150
The short description of the expiration group. -
ExpirationGroupId(optional):
string
Title:
Expiration Group ID
Maximum Length:50
The unique identifier of the expiration group. -
ExpirationRuleD(optional):
array Expiration Rules
Title:
Expiration Rules
The expiration group resource is used to create, update, or remove an expiration group. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the related expiration rule was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the related expiration rule. -
links(optional):
array Items
Title:
Items
Link Relations -
Subclassification(optional):
string
Title:
Subclassification
Maximum Length:10
The subclassification of the transaction type, which indicates that the pre-application process is included.
Nested Schema : Expiration Rules
Type:
array
Title:
Expiration Rules
The expiration group resource is used to create, update, or remove an expiration group.
Show Source
Nested Schema : publicSectorExpirationGroups-ExpirationRuleD-item
Type:
Show Source
object
-
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 whether 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 that indicates the expiration duration. -
ExpirationDurUom(optional):
string
Title:
Expiration Duration UOM
Maximum Length:5
The unit of measure for expiration duration. -
ExpirationGroupId(optional):
string
Title:
Expiration Group ID
Maximum Length:50
The unique identifier of the expiration group. -
GracePeriod(optional):
integer(int64)
Title:
Grace Period
The value that indicates 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 value of the expiration rule.
Nested Schema : link
Type:
Show Source
object
-
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.
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 ID
The unique identifier of the public sector agency. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The classification of the record type. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The name of the user who created the related expiration rule. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the related expiration rule was last updated. -
Description(optional):
string
Title:
Description
Maximum Length:1000
The long description of the expiration group. -
EffectiveEndDate(optional):
string(date)
Title:
Effective End Date
The end date for the expiration group. -
EffectiveStartDate(optional):
string(date)
Title:
Effective Start Date
The start date for the expiration group. -
EnabledFlag(optional):
boolean
Title:
Enabled
Indicates whether the expiration group is available for use. The default value is true. -
ExpirationGroup(optional):
string
Title:
Expiration Group Name
Maximum Length:150
The short description of the expiration group. -
ExpirationGroupId(optional):
string
Title:
Expiration Group ID
Maximum Length:50
The unique identifier of the expiration group. -
ExpirationRuleD(optional):
array Expiration Rules
Title:
Expiration Rules
The expiration group resource is used to create, update, or remove an expiration group. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the related expiration rule was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The name of the user who last updated the related expiration rule. -
links(optional):
array Items
Title:
Items
Link Relations -
Subclassification(optional):
string
Title:
Subclassification
Maximum Length:10
The subclassification of the transaction type, which indicates that the pre-application process is included.
Nested Schema : Expiration Rules
Type:
array
Title:
Expiration Rules
The expiration group resource is used to create, update, or remove an expiration group.
Show Source
Nested Schema : publicSectorExpirationGroups-ExpirationRuleD-item
Type:
Show Source
object
-
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 whether 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 that indicates the expiration duration. -
ExpirationDurUom(optional):
string
Title:
Expiration Duration UOM
Maximum Length:5
The unit of measure for expiration duration. -
ExpirationGroupId(optional):
string
Title:
Expiration Group ID
Maximum Length:50
The unique identifier of the expiration group. -
GracePeriod(optional):
integer(int64)
Title:
Grace Period
The value that indicates 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 value of the expiration rule.
Nested Schema : link
Type:
Show Source
object
-
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.