Create a set of expiration rules in an expiration group
post
/fscmRestApi/resources/11.13.18.05/publicSectorExpirationRules
Request
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the public sector agency. -
AteDuration: integer
(int64)
Title:
About to Expire
The value that indicates the About to Expire duration. -
AteDurUom: string
Title:
About to Expire Duration UOM
Maximum Length:5
The unit of measure for the About to Expire duration. -
CommAteFlag: string
Title:
About to Expire
Maximum Length:1
Default Value:N
Indicates that the communication is enabled for About to Expire status. -
CommAteFreqDuration: integer
(int64)
Title:
Every
Indicates the communication recurrences duration for the About to Expire status. -
CommAteFrequency: string
Title:
Recurrence
Maximum Length:7
Default Value:ORA_O
Indicates the number of communication recurrences for the About to Expire status. -
CommAteMaxFreq: integer
(int32)
Title:
Maximum Recurrences
Indicates the number of maximum communication recurrences for About to Expire status. -
CommDelinqFlag: string
Title:
Delinquent
Maximum Length:1
Default Value:N
Indicates that the communication is enabled for Delinquent status. -
CommDelinqFreqDuration: integer
(int64)
Title:
Every
Indicates the communication recurrences duration for the Delinquent status. -
CommDelinqFrequency: string
Title:
Recurrence
Maximum Length:5
Default Value:ORA_O
Indicates the number of communication recurrences for the Delinquent status. -
CommDelinqMaxFreq: integer
(int32)
Title:
Maximum Recurrences
Indicates the number of maximum communication recurrences for Delinquent status. -
CommExpireFlag: string
Title:
Expired
Maximum Length:1
Default Value:N
Indicates that the communication is enabled for Expired status. -
CommExpireFreqDuration: integer
(int64)
Title:
Every
Indicates the communication recurrences duration for Expired status. -
CommExpireFrequency: string
Title:
Recurrence
Maximum Length:7
Default Value:ORA_O
Indicates the number of communication recurrences for Expired status. -
CommExpireMaxFreq: integer
(int32)
Title:
Maximum Recurrences
Indicates the maximum number of communication recurrences for Expired status. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The end date for the expiration rule. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The start date for the expiration rule. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the expiration rule is available for use. The default value is true. -
ExpIntervalDuration: integer
(int32)
Title:
Expiration Interval
Indicates the expiration interval duration for the business license expiration rule. -
ExpIntervalDurationUom: string
Title:
Expiration Interval Unit of Measure
Maximum Length:10
The unit of measure for expiration interval duration. -
ExpirationBasis: string
Maximum Length:
10
The unique criteria derived from the record status to apply the expiration rule. -
ExpirationDuration: integer
(int64)
Title:
Expiration Duration
The value of the expiration duration. -
ExpirationDurUom: string
Title:
Expiration Duration UOM
Maximum Length:5
The unit of measure for the expiration duration. -
ExpirationGroupId: string
Title:
Expiration Group ID
Maximum Length:50
The unique identifier of the expiration rule group. -
ExpRecalcReissueFlag: string
Maximum Length:
1
Default Value:N
Indicates whether a permit should recalculate the expiration date based on the permit reissue date. -
GracePeriod: integer
(int64)
Title:
Grace Period
The value of the grace period. -
GracePeriodUom: string
Title:
Grace Period UOM
Maximum Length:5
The unit of measure for the grace period. -
InsAutoExtendFlag: string
Title:
Auto-Extend Permit Expiration
Maximum Length:1
Default Value:N
Indicates that the auto extend is enabled. -
InsCommAutoExpireFlag: string
Title:
Automatic Expiration
Maximum Length:1
Default Value:N
Indicates that the auto expire option based on the inspection commencement is enabled. -
InsCommencementDateOption: string
Title:
Date Option
Maximum Length:30
Default Value:ORA_INS_SCHEDULE
Indicate the date options for the inspection commencement. -
InsCommencementDuration: integer
(int64)
Title:
Duration
Indicates the inspection commencement duration for the Permit Expire basis. -
InsCommencementDurationUom: string
Title:
Unit of Measure
Maximum Length:5
The unit of measure for the inspection commencement duration. -
InsDurationExtend: integer
(int64)
Title:
Extension Duration
The auto extend duration value. -
InsDurationExtendUom: string
Title:
Extend Inspection Duration UOM
Maximum Length:5
Default Value:ORA_D
The unit of measure for auto extend duration. -
InsResultOption: string
Title:
Result
Maximum Length:10
Default Value:ORA_PASS
The inspection result for which expiration rule is mapped. -
NumExtensions: integer
(int32)
Title:
Number of Extensions
The number of extensions allowed for the expiration rule. -
RuleSequence: integer
(int64)
Title:
Expiration Basis
The sequence of the expiration rule.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorExpirationRules-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The unique identifier of the public sector agency. -
AteDuration: integer
(int64)
Title:
About to Expire
The value that indicates the About to Expire duration. -
AteDurUom: string
Title:
About to Expire Duration UOM
Maximum Length:5
The unit of measure for the About to Expire duration. -
CommAteFlag: string
Title:
About to Expire
Maximum Length:1
Default Value:N
Indicates that the communication is enabled for About to Expire status. -
CommAteFreqDuration: integer
(int64)
Title:
Every
Indicates the communication recurrences duration for the About to Expire status. -
CommAteFrequency: string
Title:
Recurrence
Maximum Length:7
Default Value:ORA_O
Indicates the number of communication recurrences for the About to Expire status. -
CommAteMaxFreq: integer
(int32)
Title:
Maximum Recurrences
Indicates the number of maximum communication recurrences for About to Expire status. -
CommDelinqFlag: string
Title:
Delinquent
Maximum Length:1
Default Value:N
Indicates that the communication is enabled for Delinquent status. -
CommDelinqFreqDuration: integer
(int64)
Title:
Every
Indicates the communication recurrences duration for the Delinquent status. -
CommDelinqFrequency: string
Title:
Recurrence
Maximum Length:5
Default Value:ORA_O
Indicates the number of communication recurrences for the Delinquent status. -
CommDelinqMaxFreq: integer
(int32)
Title:
Maximum Recurrences
Indicates the number of maximum communication recurrences for Delinquent status. -
CommExpireFlag: string
Title:
Expired
Maximum Length:1
Default Value:N
Indicates that the communication is enabled for Expired status. -
CommExpireFreqDuration: integer
(int64)
Title:
Every
Indicates the communication recurrences duration for Expired status. -
CommExpireFrequency: string
Title:
Recurrence
Maximum Length:7
Default Value:ORA_O
Indicates the number of communication recurrences for Expired status. -
CommExpireMaxFreq: integer
(int32)
Title:
Maximum Recurrences
Indicates the maximum number of communication recurrences for Expired status. -
EffectiveEndDate: string
(date)
Title:
Effective End Date
The end date for the expiration rule. -
EffectiveStartDate: string
(date)
Title:
Effective Start Date
The start date for the expiration rule. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates that the expiration rule is available for use. The default value is true. -
ExpIntervalDuration: integer
(int32)
Title:
Expiration Interval
Indicates the expiration interval duration for the business license expiration rule. -
ExpIntervalDurationUom: string
Title:
Expiration Interval Unit of Measure
Maximum Length:10
The unit of measure for expiration interval duration. -
ExpirationBasis: string
Maximum Length:
10
The unique criteria derived from the record status to apply the expiration rule. -
ExpirationDuration: integer
(int64)
Title:
Expiration Duration
The value of the expiration duration. -
ExpirationDurUom: string
Title:
Expiration Duration UOM
Maximum Length:5
The unit of measure for the expiration duration. -
ExpirationGroupId: string
Title:
Expiration Group ID
Maximum Length:50
The unique identifier of the expiration rule group. -
ExpRecalcReissueFlag: string
Maximum Length:
1
Default Value:N
Indicates whether a permit should recalculate the expiration date based on the permit reissue date. -
GracePeriod: integer
(int64)
Title:
Grace Period
The value of the grace period. -
GracePeriodUom: string
Title:
Grace Period UOM
Maximum Length:5
The unit of measure for the grace period. -
InsAutoExtendFlag: string
Title:
Auto-Extend Permit Expiration
Maximum Length:1
Default Value:N
Indicates that the auto extend is enabled. -
InsCommAutoExpireFlag: string
Title:
Automatic Expiration
Maximum Length:1
Default Value:N
Indicates that the auto expire option based on the inspection commencement is enabled. -
InsCommencementDateOption: string
Title:
Date Option
Maximum Length:30
Default Value:ORA_INS_SCHEDULE
Indicate the date options for the inspection commencement. -
InsCommencementDuration: integer
(int64)
Title:
Duration
Indicates the inspection commencement duration for the Permit Expire basis. -
InsCommencementDurationUom: string
Title:
Unit of Measure
Maximum Length:5
The unit of measure for the inspection commencement duration. -
InsDurationExtend: integer
(int64)
Title:
Extension Duration
The auto extend duration value. -
InsDurationExtendUom: string
Title:
Extend Inspection Duration UOM
Maximum Length:5
Default Value:ORA_D
The unit of measure for auto extend duration. -
InsResultOption: string
Title:
Result
Maximum Length:10
Default Value:ORA_PASS
The inspection result for which expiration rule is mapped. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NumExtensions: integer
(int32)
Title:
Number of Extensions
The number of extensions allowed for the expiration rule. -
RuleSequence: integer
(int64)
Title:
Expiration Basis
The sequence of the expiration rule.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.