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
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorExpirationRules-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. -
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. -
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. -
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.
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 : publicSectorExpirationRules-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. -
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. -
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. -
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.
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.