Jump to

• Request
• Response

Get all expiration groups

get

/fscmRestApi/resources/11.13.18.05/publicSectorExpirationGroups

Request

Query Parameters

• dependency: string
  This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables:
  
  

  • PrimaryKey: Finds the expiration group that matches the specified primary key criteria. Finder Variables:
    • AgencyId; integer; The unique identifier of the public sector agency.
    • EffectiveEndDate; string; The end date for the expiration group.
    • EffectiveStartDate; string; The start date for the expiration group.
    • ExpirationGroupId; string; The unique identifier of the expiration group.
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourcecollection+json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorExpirationGroups

Type: object

Show Source

• count(optional): integer
  Title: Count

  The number of resource instances returned in the current range.
• hasMore(optional): boolean
  Title: HasMore

  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items(optional): array Items
  Title: Items

  The items in the collection.
• limit(optional): integer
  Title: Limit

  The actual paging size used by the server.
• links(optional): array Items
  Title: Items

  The link relations associated with the resource instance.
• offset(optional): integer
  Title: Offset

  The offset value used in the current page.

{
    "properties":{
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range.",
            "title":"Count"
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.",
            "title":"HasMore"
        },
        "items":{
            "items":{
                "$ref":"#/definitions/publicSectorExpirationGroups-item"
            },
            "type":"array",
            "description":"The items in the collection.",
            "title":"Items"
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server.",
            "title":"Limit"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "title":"Items"
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page.",
            "title":"Offset"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object publicSectorExpirationGroups-item

{
    "items":{
        "$ref":"#/definitions/publicSectorExpirationGroups-item"
    },
    "type":"array",
    "description":"The items in the collection.",
    "title":"Items"
}

Nested Schema : Items

Type: array

Title: Items

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "title":"Items"
}

Nested Schema : publicSectorExpirationGroups-item

Type: object

Show Source

• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the public sector agency.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The classification of the record type.
• 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 last updated.
• Description(optional): string
  Title: Description

  Maximum Length: 1000

  The long description of the expiration group.
• EffectiveEndDate(optional): string(date)
  Title: Effective End Date

  The end date for the expiration group.
• EffectiveStartDate(optional): string(date)
  Title: Effective Start Date

  The start date for the expiration group.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the expiration group is available for use. The default value is true.
• ExpirationGroup(optional): string
  Title: Expiration Group Name

  Maximum Length: 150

  The short description of the expiration group.
• ExpirationGroupId(optional): string
  Title: Expiration Group ID

  Maximum Length: 50

  The unique identifier of the expiration group.
• ExpirationRuleD(optional): array Expiration Rules
  Title: Expiration Rules

  The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.
• 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
• Subclassification(optional): string
  Title: Subclassification

  Maximum Length: 10

  The subclassification of the transaction type, which indicates that the pre-application process is included.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "Classification":{
            "maxLength":3,
            "type":"string",
            "description":"The classification of the record type.",
            "title":"Classification"
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who created the related expiration rule.",
            "title":"Created By"
        },
        "CreationDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related expiration rule was last updated.",
            "title":"Creation Date"
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The long description of the expiration group.",
            "title":"Description"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date for the expiration group.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date for the expiration group.",
            "title":"Effective Start Date"
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the expiration group is available for use. The default value is true.",
            "title":"Enabled"
        },
        "ExpirationGroup":{
            "maxLength":150,
            "type":"string",
            "description":"The short description of the expiration group.",
            "title":"Expiration Group Name"
        },
        "ExpirationGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the expiration group.",
            "title":"Expiration Group ID"
        },
        "ExpirationRuleD":{
            "items":{
                "$ref":"#/definitions/publicSectorExpirationGroups-ExpirationRuleD-item"
            },
            "type":"array",
            "description":"The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.",
            "title":"Expiration Rules"
        },
        "LastUpdateDate":{
            "format":"date-time",
            "type":"string",
            "description":"The date when the related expiration rule was last updated.",
            "title":"Last Updated Date"
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The name of the user who last updated the related expiration rule.",
            "title":"Last Updated By"
        },
        "Subclassification":{
            "maxLength":10,
            "type":"string",
            "description":"The subclassification of the transaction type, which indicates that the pre-application process is included.",
            "title":"Subclassification"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

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

• Array of: object publicSectorExpirationGroups-ExpirationRuleD-item

{
    "items":{
        "$ref":"#/definitions/publicSectorExpirationGroups-ExpirationRuleD-item"
    },
    "type":"array",
    "description":"The expiration rule resource is used to create, update, or remove expiration rules from an expiration group.",
    "title":"Expiration Rules"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : publicSectorExpirationGroups-ExpirationRuleD-item

Type: object

Show Source

• 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.
• CommDelinqFlag(optional): string
  Title: Delinquent

  Maximum Length: 1

  Indicates that the communication is enabled for Delinquent status.
• CommDelinqFreqDuration(optional): integer(int64)
  Title: Every

  Indicates the comunication recurrences duration for the Delinquent status.
• CommDelinqFrequency(optional): string
  Title: Recurrence

  Maximum Length: 5

  Indicates the number of comunication recurrences for the Delinquent status.
• CommDelinqMaxFreq(optional): integer(int32)
  Title: Maximum Recurrences

  Indicates the number of maximum communication recurrences for Delinquent 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 whether the expiration rule is available for use. The default value is true.
• ExpIntervalDuration(optional): integer(int32)
  Title: Expiration Interval

  Indicates the expiration interval duration for the business license expiration rule.
• ExpIntervalDurationUom(optional): string
  Title: Expiration Interval Unit of Measure

  Maximum Length: 10

  The unit of measure for expiration interval duration.
• 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 UOM

  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 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.
• InsCommAutoExpireFlag(optional): string
  Title: Automatic Expiration

  Maximum Length: 1

  Indicates that the auto expire option based on the inspection commencement is enabled.
• InsCommencementDateOption(optional): string
  Title: Date Option

  Maximum Length: 30

  Indicate the date options for the inspection commencement.
• InsCommencementDuration(optional): integer(int64)
  Title: Duration

  Indicates the inspection commencement duration for the Permit Expire basis.
• InsCommencementDurationUom(optional): string
  Title: Unit of Measure

  Maximum Length: 5

  The unit of measure for the inspection commencement duration.
• 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 value of the expiration rule.

{
    "properties":{
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the public sector agency.",
            "title":"Agency ID"
        },
        "AteDurUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the About to Expire duration.",
            "title":"About to Expire Duration UOM"
        },
        "AteDuration":{
            "format":"int64",
            "type":"integer",
            "description":"The value that indicates the About to Expire duration.",
            "title":"About to Expire"
        },
        "CommAteFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for About to Expire status.",
            "title":"About to Expire"
        },
        "CommAteFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for the About to Expire status.",
            "title":"Every"
        },
        "CommAteFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates the number of comunication recurrences for the About to Expire status.",
            "title":"Recurrence"
        },
        "CommAteMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for About to Expire status.",
            "title":"Maximum Recurrences"
        },
        "CommDelinqFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for Delinquent status.",
            "title":"Delinquent"
        },
        "CommDelinqFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for the Delinquent status.",
            "title":"Every"
        },
        "CommDelinqFrequency":{
            "maxLength":5,
            "type":"string",
            "description":"Indicates the number of comunication recurrences for the Delinquent status.",
            "title":"Recurrence"
        },
        "CommDelinqMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the number of maximum communication recurrences for Delinquent status.",
            "title":"Maximum Recurrences"
        },
        "CommExpireFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the communication is enabled for Expired status.",
            "title":"Expired"
        },
        "CommExpireFreqDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the comunication recurrences duration for Expired status.",
            "title":"Every"
        },
        "CommExpireFrequency":{
            "maxLength":7,
            "type":"string",
            "description":"Indicates the number of communication recurrences for Expired status.",
            "title":"Recurrence"
        },
        "CommExpireMaxFreq":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the maximum number of communication recurrences for Expired status.",
            "title":"Maximum Recurrences"
        },
        "EffectiveEndDate":{
            "format":"date",
            "type":"string",
            "description":"The end date for the expiration rule.",
            "title":"Effective End Date"
        },
        "EffectiveStartDate":{
            "format":"date",
            "type":"string",
            "description":"The start date for the expiration rule.",
            "title":"Effective Start Date"
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates whether the expiration rule is available for use. The default value is true.",
            "title":"Enabled"
        },
        "ExpIntervalDuration":{
            "format":"int32",
            "type":"integer",
            "description":"Indicates the expiration interval duration for the business license expiration rule.",
            "title":"Expiration Interval"
        },
        "ExpIntervalDurationUom":{
            "maxLength":10,
            "type":"string",
            "description":"The unit of measure for expiration interval duration.",
            "title":"Expiration Interval Unit of Measure"
        },
        "ExpirationBasis":{
            "maxLength":10,
            "type":"string",
            "description":"The unique criteria derived from the record status to apply the expiration rule."
        },
        "ExpirationDurUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for expiration duration.",
            "title":"Expiration Duration UOM"
        },
        "ExpirationDuration":{
            "format":"int64",
            "type":"integer",
            "description":"The value that indicates the expiration duration.",
            "title":"Expiration Duration"
        },
        "ExpirationGroupId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the expiration group.",
            "title":"Expiration Group ID"
        },
        "GracePeriod":{
            "format":"int64",
            "type":"integer",
            "description":"The value that indicates the grace period.",
            "title":"Grace Period"
        },
        "GracePeriodUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the grace period.",
            "title":"Grace Period UOM"
        },
        "InsAutoExtendFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the auto extend is enabled.",
            "title":"Auto-Extend Permit Expiration"
        },
        "InsCommAutoExpireFlag":{
            "maxLength":1,
            "type":"string",
            "description":"Indicates that the auto expire option based on the inspection commencement is enabled.",
            "title":"Automatic Expiration"
        },
        "InsCommencementDateOption":{
            "maxLength":30,
            "type":"string",
            "description":"Indicate the date options for the inspection commencement.",
            "title":"Date Option"
        },
        "InsCommencementDuration":{
            "format":"int64",
            "type":"integer",
            "description":"Indicates the inspection commencement duration for the Permit Expire basis.",
            "title":"Duration"
        },
        "InsCommencementDurationUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for the inspection commencement duration.",
            "title":"Unit of Measure"
        },
        "InsDurationExtend":{
            "format":"int64",
            "type":"integer",
            "description":"The auto extend duration value.",
            "title":"Extension Duration"
        },
        "InsDurationExtendUom":{
            "maxLength":5,
            "type":"string",
            "description":"The unit of measure for auto extend duration.",
            "title":"Extend Inspection Duration UOM"
        },
        "InsResultOption":{
            "maxLength":10,
            "type":"string",
            "description":"The inspection result for which expiration rule is mapped.",
            "title":"Result"
        },
        "NumExtensions":{
            "format":"int32",
            "type":"integer",
            "description":"The number of extensions allowed for the expiration rule.",
            "title":"Number of Extensions"
        },
        "RuleSequence":{
            "format":"int64",
            "type":"integer",
            "description":"The sequence value of the expiration rule.",
            "title":"Expiration Basis"
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top