Jump to

• Request
• Response

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:
  When set to true, the server will perform an Upsert operation instead of a Create. In an Upsert operation the server attempts to find an existing resource that matches the payload. If found, the server updates the existing resource instead of creating a new one. If not found, or when set to false (the default), a Create is performed.

Supported Media Types

• application/json

Request Body - application/json ()

The following table describes the body parameters in the request for this task.

Root Schema : schema

Type: object

Show Source

• 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 comunication recurrences duration for the About to Expire status.
• CommAteFrequency: string
  Title: Recurrence

  Maximum Length: 7

  Default Value: ORA_O

  Indicates the number of comunication 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 comunication recurrences duration for the Delinquent status.
• CommDelinqFrequency: string
  Title: Recurrence

  Maximum Length: 5

  Default Value: ORA_O

  Indicates the number of comunication 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 comunication 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.
• 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.

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

Back to Top

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.

Body ()

Root Schema : publicSectorExpirationRules-item-response

Type: object

Show Source

• 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 comunication recurrences duration for the About to Expire status.
• CommAteFrequency: string
  Title: Recurrence

  Maximum Length: 7

  Default Value: ORA_O

  Indicates the number of comunication 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 comunication recurrences duration for the Delinquent status.
• CommDelinqFrequency: string
  Title: Recurrence

  Maximum Length: 5

  Default Value: ORA_O

  Indicates the number of comunication 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 comunication 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.
• 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.

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

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

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

Nested Schema : link

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top