Create a set of expiration rules in an expiration group
post
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}/child/ExpirationRuleD
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorExpirationGroupsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ExpirationGroupId, EffectiveStartDate and EffectiveEndDate ---for the Expiration Groups resource and used to uniquely identify an instance of Expiration Groups. The client should not generate the hash key value. Instead, the client should query on the Expiration Groups collection resource with a filter on the primary key values in order to navigate to a specific instance of Expiration Groups.
For example: publicSectorExpirationGroups?q=AgencyId=<value1>;ExpirationGroupId=<value2>;EffectiveStartDate=<value3>;EffectiveEndDate=<value4>
The following table describes the body parameters in the request for this task.
Root 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
Maximum Length:5
The unit of measure for the About to Expire duration. -
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 created. -
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. -
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
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
Maximum Length:5
The unit of measure for the grace period. -
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 -
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-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
Maximum Length:5
The unit of measure for the About to Expire duration. -
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 created. -
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. -
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
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
Maximum Length:5
The unit of measure for the grace period. -
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 -
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.