Update an expiration rule in an expiration group
patch
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules/{publicSectorExpirationRulesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorExpirationRulesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ExpirationGroupId, EffectiveStartDate, EffectiveEndDate and ExpirationBasis ---for the Expiration Rules resource and used to uniquely identify an instance of Expiration Rules. The client should not generate the hash key value. Instead, the client should query on the Expiration Rules collection resource with a filter on the primary key values in order to navigate to a specific instance of Expiration Rules.
For example: publicSectorExpirationRules?q=AgencyId=<value1>;ExpirationGroupId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>;ExpirationBasis=<value5>
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 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. -
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 that the expiration rule is available for use. The default value is true. -
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 of the expiration duration. -
ExpirationDurUom(optional):
string
Title:
Expiration Duration UOMMaximum Length:5The unit of measure for the expiration duration. -
ExpirationGroupId(optional):
string
Title:
Expiration Group IDMaximum Length:50The unique identifier of the expiration rule group. -
GracePeriod(optional):
integer(int64)
Title:
Grace PeriodThe value of 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. -
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 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 : publicSectorExpirationRules-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. -
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 that the expiration rule is available for use. The default value is true. -
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 of the expiration duration. -
ExpirationDurUom(optional):
string
Title:
Expiration Duration UOMMaximum Length:5The unit of measure for the expiration duration. -
ExpirationGroupId(optional):
string
Title:
Expiration Group IDMaximum Length:50The unique identifier of the expiration rule group. -
GracePeriod(optional):
integer(int64)
Title:
Grace PeriodThe value of 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. -
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 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.