1. REST API for Oracle Public Sector Permitting and Licensing
  2. Tasks
  3. Common Setup
  4. Expiration Groups

Update an expiration group

patch

/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups/{publicSectorExpirationGroupsUniqID}

Request

Path Parameters
  • 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>
Header Parameters
  • This header accepts a string value. The string is a semi-colon separated list of =. It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers.
  • 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".
  • 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.
Supported Media Types
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
  • Title: Classification
    Maximum Length: 3
    The classification of the record type.
  • Title: Description
    Maximum Length: 1000
    The long description of the expiration group.
  • Title: Enabled
    Maximum Length: 1
    Default Value: true
    Indicates whether the expiration group is available for use. The default value is true.
  • Title: Expiration Group Name
    Maximum Length: 150
    The short description of the expiration group.
  • Maximum Length: 1
    Indicates whether renewal is allowed on the expiration group. The default value is false.
  • Expiration Rules
    Title: Expiration Rules
    The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.
  • Title: Subclassification
    Maximum Length: 10
    Default Value: ORA_NA
    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 rule resource is used to create, update, or remove expiration rules from an expiration group.
Show Source
Nested Schema : schema
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : publicSectorExpirationGroups-item-response
Type: object
Show Source
Nested Schema : Expiration Rules
Type: array
Title: Expiration Rules
The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.
Show Source
Nested Schema : publicSectorExpirationGroups-ExpirationRuleD-item-response
Type: object
Show Source
Links
ExpirationRuleD
Parameters:
  • publicSectorExpirationGroupsUniqID: $request.path.publicSectorExpirationGroupsUniqID
The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.
Back to Top