Jump to

• Request
• Response

Create a record type

post

/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• ActivityGroupId: string
  Title: Activity Group

  Maximum Length: 30

  The identifier for the group ID for license activity.
• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The identifier for a public sector agency associated with the record type.
• AllowPublicUserView: string
  Title: Allow Public User to View

  Maximum Length: 1

  Default Value: N

  Indicates whether the public user has view access to the report. The default value is N.
• ApplGroup: string
  Title: Permit Group

  Maximum Length: 30

  The highest level of categorization to which the record type belongs.
• BillType: string
  Title: Bill Type

  Maximum Length: 15

  The bill type associated with the record type.
• Category: string
  Title: Category

  Maximum Length: 30

  The record type category.
• CitizenEnabled(required): string
  Title: Public User Enabled

  Maximum Length: 1

  Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.
• Classification(required): string
  Title: Classification

  Maximum Length: 3

  The classification of the record type.
• CloneRecordTypeCode: string
  Title: Original Permit Type Code

  The short name for a cloned record type.
• CloneReviewerDepts: string
  The record type ID for cloning plan review departments for a record type.
• CntrctrValidationGroupId: string
  Title: Contractor Validation

  Maximum Length: 50

  A unique name that identifies a contractor validation group.
• CoaReportId: string
  Title: Conditions of Approval Report ID

  Maximum Length: 32

  The Identifier for COA report.
• CoaTemplateId: string
  Title: Conditions of Approval Template

  Maximum Length: 20

  The identifier for COA template.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The department associated with the record type.
• Description: string
  Title: Description

  Maximum Length: 1000

  The long description for the record type.
• DocGroupId: string
  Title: Document Group

  Maximum Length: 30

  Indicates the document group, which is defined by a set of attachment document categories.
• ExpirationAmend: string
  Title: Allow Amendment

  Maximum Length: 1

  Default Value: N

  Indicates whether the transaction can be amended by a user. The default value is N.
• ExpirationGroupId: string
  Title: Expiration Group ID

  Maximum Length: 50

  Identifies the expiration group associated with the record type.
• ExpirationRenew: string
  Title: Allow Renewal

  Maximum Length: 1

  Default Value: N

  Indicates whether the transaction can be renewed by a user. The default value is N.
• FeeScheduleId: string
  Title: Fee Schedule

  Maximum Length: 20

  The identifier for the fee schedule associated with the record type.
• HearingOption: string
  Title: Hearing

  Maximum Length: 10

  Indicates whether a public hearing is applicable for the transaction type.
• InspectionGroup: string
  Title: Origination Inspection Group

  Maximum Length: 15

  The group of inspections if multiple inspections are required for the record type.
• InspectionGroupAmend: string
  Title: Amendment Inspection Group

  Maximum Length: 15

  The inspection group for amendments.
• InspectionGroupRenew: string
  Title: Renewal Inspection Group

  Maximum Length: 15

  The inspection group for renewals.
• MeetTemplateId: string
  Maximum Length: 30

  The identifier of the meeting template associated with the record type.
• NaicsGroupCode: string
  Title: NAICS Group

  Maximum Length: 30

  The identifier for a North American Industry Classification System (NAICS) group.
• OpaPolicyName: string
  Title: Policy

  Maximum Length: 200

  The Oracle Policy Automation template associated with the record type.
• OpaPolicyVersion: string
  Title: Policy Version

  Maximum Length: 20

  The Oracle Policy Automation policy version.
• PlanReview: string
  Title: Enable Plan Review

  Maximum Length: 10

  Indicates the type of plan review that can be created for the transaction type. The plan review type can be manual or electronic document review.
• PlanReviewTimeRuleId: string
  Title: Cycle Time Rule

  Maximum Length: 50

  The time rule identifier that is used to calculate the due date for plan review.
• RecordType(required): string
  Title: Permit Type

  Maximum Length: 100

  The user-friendly name for the record type.
• RecordTypeCode(required): string
  Title: Permit Type Code

  Maximum Length: 20

  The unique alphanumeric code or short name for the record type.
• RecordTypeId(required): string
  Title: Permit Type ID

  Maximum Length: 30

  The unique identifier for the record type.
• RecordTypePlanReviewerDepartment: array Record Type Plan Reviewer Departments
  Title: Record Type Plan Reviewer Departments

  The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.
• RecordTypeState(required): string
  Title: Permit Type Status

  Maximum Length: 10

  The status of the record type. The default value is preliminary.
• RelatedRec: array Related Record Types
  Title: Related Record Types

  The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.
• ReportControlId: string
  Title: Certificate Report ID

  Maximum Length: 32

  The identifier for the report control.
• ReportGroup: string
  Title: Report Group

  Maximum Length: 100

  The label for the report group.
• ReviewerAutoAssign: string
  Title: Enable Auto Assignment

  Maximum Length: 1

  Default Value: N

  Indicates whether a plan reviewer will be automatically assigned to the plan review. The default value is N.
• RuleId(required): string
  Title: Autonumber Rule

  Maximum Length: 20

  The autonumber rule used to create the identifier for record transactions.
• Subcategory: string
  Title: Subcategory

  Maximum Length: 30

  The record type subcategory.
• Subclassification: string
  Title: Subclassification

  Maximum Length: 10

  The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
• TaxClassCode: string
  Title: Tax Class

  Maximum Length: 50

  The identifier for the tax class code.
• TermsUseId: string
  Title: Terms of Use ID

  Maximum Length: 15

  The terms and use ID associated with the record type.
• TransPeriodFormat: string
  Title: License Period Format

  Maximum Length: 30

  Default Value: yyyy

  The display format for the transaction period date.
• Url: string
  Title: URL

  The URL provides a link that the user can click to navigate to other pages with more information.
• ValidFromDate(required): string (date)
  Title: Valid from Date

  The date when the record type is valid to use.
• ValidToDate(required): string (date)
  Title: Valid to Date

  The date when the record type is no longer valid to use.
• WfNoAmendFlag: string
  Title: No Amendment Workflow

  Maximum Length: 1

  Indicates that the transaction type does not contain an amendment workflow. If the value is Y, the workflow is disabled for amendment. The default value is N.
• WfNoOrigFlag: string
  Title: No Application Workflow

  Maximum Length: 1

  Indicates that the transaction type does not contain an original workflow. If the value is Y, the workflow is disabled for origination. The default value is N.
• WfNoRenewFlag: string
  Title: No Renewal Workflow

  Maximum Length: 1

  Indicates that the transaction type does not contain a renewal workflow. If the value is Y, the workflow is disabled for renewal. The default value is N.
• WfProcDefIdAmend: string
  Title: Amendment Process Name

  Maximum Length: 1000

  The workflow process definition ID used to define the workflow for an amended permit.
• WfProcDefIdOrig: string
  Title: Workflow Process Definition

  Maximum Length: 1000

  The workflow process definition ID used to define the workflow for an original permit.
• WfProcDefIdRenew: string
  Title: Renewal Process Definition

  Maximum Length: 1000

  The workflow process definition ID used to define the workflow for a renewed permit.
• WfProcVersionAmend: string
  Title: Amendment Version

  Maximum Length: 50

  The workflow project revision number used to define the workflow for an amended permit.
• WfProcVersionOrig: string
  Title: Workflow Version

  Maximum Length: 50

  The workflow project revision number used to define the workflow for an original permit.
• WfProcVersionRenew: string
  Title: Renewal Version

  Maximum Length: 50

  The workflow project revision number used to define the workflow for a renewed permit.
• WfProjectAmend: string
  Title: Amendment Application

  Maximum Length: 500

  The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.
• WfProjectOrig: string
  Title: Workflow Application ID

  Maximum Length: 500

  The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.
• WfProjectRenew: string
  Title: Renewal Application

  Maximum Length: 500

  The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.
• WfSpaceAmend: string
  Title: Amendment Space Name

  Maximum Length: 50

  The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.
• WfSpaceNameAmend: string
  Title: Amendment Space Name

  Maximum Length: 1000

  The name of the workflow space that was used to define the workflow process for an amended permit.
• WfSpaceNameOrig: string
  Title: Workflow Space Name

  Maximum Length: 1000

  The name of the workflow space that was used to define the workflow process for an original permit.
• WfSpaceNameRenew: string
  Title: Renewal Space Name

  Maximum Length: 1000

  The name of the workflow space that was used to define the workflow process for a renewed permit.
• WfSpaceOrig: string
  Title: Workflow Space Name

  Maximum Length: 50

  The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.
• WfSpaceRenew: string
  Title: Renewal Space Name

  Maximum Length: 50

  The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.

{
    "required":[
        "CitizenEnabled",
        "Classification",
        "RecordType",
        "RecordTypeCode",
        "RecordTypeId",
        "RecordTypeState",
        "RuleId",
        "ValidFromDate",
        "ValidToDate"
    ],
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.",
            "nullable":true
        },
        "ExpirationGroupId":{
            "title":"Expiration Group ID",
            "maxLength":"50",
            "type":"string",
            "description":"Identifies the expiration group associated with the record type.",
            "nullable":true
        },
        "ExpirationAmend":{
            "title":"Allow Amendment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the transaction can be amended by a user. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "CntrctrValidationGroupId":{
            "title":"Contractor Validation",
            "maxLength":"50",
            "type":"string",
            "description":"A unique name that identifies a contractor validation group.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "RecordTypePlanReviewerDepartment":{
            "title":"Record Type Plan Reviewer Departments",
            "type":"array",
            "description":"The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-post-request"
            }
        },
        "WfSpaceNameAmend":{
            "title":"Amendment Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the workflow space that was used to define the workflow process for an amended permit.",
            "nullable":true
        },
        "ReviewerAutoAssign":{
            "title":"Enable Auto Assignment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a plan reviewer will be automatically assigned to the plan review. The default value is N.",
            "nullable":true,
            "default":"N"
        },
        "TaxClassCode":{
            "title":"Tax Class",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the tax class code.",
            "nullable":true
        },
        "WfProjectAmend":{
            "title":"Amendment Application",
            "maxLength":"500",
            "type":"string",
            "description":"The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.",
            "nullable":true
        },
        "PlanReviewTimeRuleId":{
            "title":"Cycle Time Rule",
            "maxLength":"50",
            "type":"string",
            "description":"The time rule identifier that is used to calculate the due date for plan review.",
            "nullable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false
        },
        "OpaPolicyVersion":{
            "title":"Policy Version",
            "maxLength":"20",
            "type":"string",
            "description":"The Oracle Policy Automation policy version.",
            "nullable":true
        },
        "WfSpaceNameRenew":{
            "title":"Renewal Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the workflow space that was used to define the workflow process for a renewed permit.",
            "nullable":true
        },
        "TransPeriodFormat":{
            "title":"License Period Format",
            "maxLength":"30",
            "type":"string",
            "description":"The display format for the transaction period date.",
            "nullable":true,
            "default":"yyyy"
        },
        "FeeScheduleId":{
            "title":"Fee Schedule",
            "maxLength":"20",
            "type":"string",
            "description":"The identifier for the fee schedule associated with the record type.",
            "nullable":true
        },
        "InspectionGroupAmend":{
            "title":"Amendment Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The inspection group for amendments.",
            "nullable":true
        },
        "ValidToDate":{
            "title":"Valid to Date",
            "type":"string",
            "description":"The date when the record type is no longer valid to use.",
            "format":"date",
            "nullable":false
        },
        "WfProjectRenew":{
            "title":"Renewal Application",
            "maxLength":"500",
            "type":"string",
            "description":"The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.",
            "nullable":true
        },
        "WfSpaceAmend":{
            "title":"Amendment Space Name",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.",
            "nullable":true
        },
        "InspectionGroupRenew":{
            "title":"Renewal Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The inspection group for renewals.",
            "nullable":true
        },
        "WfSpaceOrig":{
            "title":"Workflow Space Name",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.",
            "nullable":true
        },
        "ActivityGroupId":{
            "title":"Activity Group",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for the group ID for license activity.",
            "nullable":true
        },
        "ApplGroup":{
            "title":"Permit Group",
            "maxLength":"30",
            "type":"string",
            "description":"The highest level of categorization to which the record type belongs.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "ValidFromDate":{
            "title":"Valid from Date",
            "type":"string",
            "description":"The date when the record type is valid to use.",
            "format":"date",
            "nullable":false
        },
        "WfProjectOrig":{
            "title":"Workflow Application ID",
            "maxLength":"500",
            "type":"string",
            "description":"The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.",
            "nullable":true
        },
        "DocGroupId":{
            "title":"Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the document group, which is defined by a set of attachment document categories.",
            "nullable":true
        },
        "WfProcVersionOrig":{
            "title":"Workflow Version",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow project revision number used to define the workflow for an original permit.",
            "nullable":true
        },
        "WfProcDefIdAmend":{
            "title":"Amendment Process Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition ID used to define the workflow for an amended permit.",
            "nullable":true
        },
        "ReportControlId":{
            "title":"Certificate Report ID",
            "maxLength":"32",
            "type":"string",
            "description":"The identifier for the report control.",
            "nullable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The record type category.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description for the record type.",
            "nullable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for a public sector agency associated with the record type.",
            "nullable":false,
            "default":"1"
        },
        "PlanReview":{
            "title":"Enable Plan Review",
            "maxLength":"10",
            "type":"string",
            "description":"Indicates the type of plan review that can be created for the transaction type. The plan review type can be manual or electronic document review.",
            "nullable":true
        },
        "CloneRecordTypeCode":{
            "title":"Original Permit Type Code",
            "type":"string",
            "description":"The short name for a cloned record type.",
            "nullable":true
        },
        "RecordTypeState":{
            "title":"Permit Type Status",
            "maxLength":"10",
            "type":"string",
            "description":"The status of the record type. The default value is preliminary.",
            "nullable":false
        },
        "CitizenEnabled":{
            "title":"Public User Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.",
            "nullable":false
        },
        "RuleId":{
            "title":"Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule used to create the identifier for record transactions.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "Subclassification"
                ]
            }
        },
        "WfNoAmendFlag":{
            "title":"No Amendment Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the transaction type does not contain an amendment workflow. If the value is Y, the workflow is disabled for amendment. The default value is N.",
            "nullable":true
        },
        "NaicsGroupCode":{
            "title":"NAICS Group",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for a North American Industry Classification System (NAICS) group.",
            "nullable":true
        },
        "WfProcVersionRenew":{
            "title":"Renewal Version",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow project revision number used to define the workflow for a renewed permit.",
            "nullable":true
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "nullable":true,
            "x-queryable":false
        },
        "WfSpaceRenew":{
            "title":"Renewal Space Name",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.",
            "nullable":true
        },
        "AllowPublicUserView":{
            "title":"Allow Public User to View",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the public user has view access to the report. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "RecordTypeCode":{
            "title":"Permit Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "WfProcVersionAmend":{
            "title":"Amendment Version",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow project revision number used to define the workflow for an amended permit.",
            "nullable":true
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":false
        },
        "MeetTemplateId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the meeting template associated with the record type.",
            "nullable":true
        },
        "RecordTypeId":{
            "title":"Permit Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type.",
            "nullable":false,
            "x-hints":{
                "promptList":"Y"
            }
        },
        "HearingOption":{
            "title":"Hearing",
            "maxLength":"10",
            "type":"string",
            "description":"Indicates whether a public hearing is applicable for the transaction type.",
            "nullable":true
        },
        "InspectionGroup":{
            "title":"Origination Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The group of inspections if multiple inspections are required for the record type.",
            "nullable":true
        },
        "TermsUseId":{
            "title":"Terms of Use ID",
            "maxLength":"15",
            "type":"string",
            "description":"The terms and use ID associated with the record type.",
            "nullable":true
        },
        "WfSpaceNameOrig":{
            "title":"Workflow Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the workflow space that was used to define the workflow process for an original permit.",
            "nullable":true
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":"15",
            "type":"string",
            "description":"The bill type associated with the record type.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Subclassification"
                ]
            }
        },
        "CloneReviewerDepts":{
            "type":"string",
            "description":"The record type ID for cloning plan review departments for a record type.",
            "nullable":true
        },
        "CoaReportId":{
            "title":"Conditions of Approval Report ID",
            "maxLength":"32",
            "type":"string",
            "description":"The Identifier for COA report.",
            "nullable":true
        },
        "WfProcDefIdRenew":{
            "title":"Renewal Process Definition",
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition ID used to define the workflow for a renewed permit.",
            "nullable":true
        },
        "OpaPolicyName":{
            "title":"Policy",
            "maxLength":"200",
            "type":"string",
            "description":"The Oracle Policy Automation template associated with the record type.",
            "nullable":true
        },
        "WfNoRenewFlag":{
            "title":"No Renewal Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the transaction type does not contain a renewal workflow. If the value is Y, the workflow is disabled for renewal. The default value is N.",
            "nullable":true
        },
        "CoaTemplateId":{
            "title":"Conditions of Approval Template",
            "maxLength":"20",
            "type":"string",
            "description":"The identifier for COA template.",
            "nullable":true
        },
        "ReportGroup":{
            "title":"Report Group",
            "maxLength":"100",
            "type":"string",
            "description":"The label for the report group.",
            "nullable":true
        },
        "ExpirationRenew":{
            "title":"Allow Renewal",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the transaction can be renewed by a user. The default value is N.",
            "nullable":false,
            "default":"N"
        },
        "RelatedRec":{
            "title":"Related Record Types",
            "type":"array",
            "description":"The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordTypes-RelatedRec-item-post-request"
            }
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The record type subcategory.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            }
        },
        "WfNoOrigFlag":{
            "title":"No Application Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the transaction type does not contain an original workflow. If the value is Y, the workflow is disabled for origination. The default value is N.",
            "nullable":true
        },
        "WfProcDefIdOrig":{
            "title":"Workflow Process Definition",
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition ID used to define the workflow for an original permit.",
            "nullable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The department associated with the record type.",
            "nullable":true
        }
    }
}

Nested Schema : Record Type Plan Reviewer Departments

Type: array

Title: Record Type Plan Reviewer Departments

The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.

Show Source

• Array of: object schema

{
    "title":"Record Type Plan Reviewer Departments",
    "type":"array",
    "description":"The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-post-request"
    }
}

Nested Schema : Related Record Types

Type: array

Title: Related Record Types

The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.

Show Source

• Array of: object publicSectorRecordTypes-RelatedRec-item-post-request

{
    "title":"Related Record Types",
    "type":"array",
    "description":"The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordTypes-RelatedRec-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the record type plan reviewer departments.
• DepartmentId: string
  Title: Plan Reviewer Department

  Maximum Length: 30

  The identifier for record type plan reviewer departments.
• RecordTypeCode: string
  Maximum Length: 20

  The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments.
• RecordTypeId: string
  Maximum Length: 30

  The identifier for the record type associated with the record type plan reviewer departments.
• RequiredFlag: boolean
  Title: Required Department

  Maximum Length: 1

  Indicates whether the department is required to review the documents.
• TimeRuleId: string
  Maximum Length: 50

  The time rule identifier that is used to calculate the due date.

{
    "type":"object",
    "properties":{
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the record type plan reviewer departments.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            }
        },
        "TimeRuleId":{
            "maxLength":"50",
            "type":"string",
            "description":"The time rule identifier that is used to calculate the due date.",
            "nullable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for the record type associated with the record type plan reviewer departments.",
            "nullable":false
        },
        "RequiredFlag":{
            "title":"Required Department",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the department is required to review the documents.",
            "nullable":true
        },
        "DepartmentId":{
            "title":"Plan Reviewer Department",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for record type plan reviewer departments.",
            "nullable":false
        }
    }
}

Nested Schema : publicSectorRecordTypes-RelatedRec-item-post-request

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency associated with the related record type.
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier for the record type.
• RelatedTypeId: string
  Title: Related Record Type ID

  Maximum Length: 30

  The unique identifier for the related record type.

{
    "type":"object",
    "properties":{
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type.",
            "nullable":false
        },
        "RelatedTypeId":{
            "title":"Related Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the related record type.",
            "nullable":false
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the related record type.",
            "nullable":false,
            "default":"1"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

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

Body ()

Root Schema : publicSectorRecordTypes-item-response

Type: object

Show Source

• ActivityGroupId: string
  Title: Activity Group

  Maximum Length: 30

  The identifier for the group ID for license activity.
• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The identifier for a public sector agency associated with the record type.
• AllowPublicUserView: string
  Title: Allow Public User to View

  Maximum Length: 1

  Default Value: N

  Indicates whether the public user has view access to the report. The default value is N.
• ApplGroup: string
  Title: Permit Group

  Maximum Length: 30

  The highest level of categorization to which the record type belongs.
• BillType: string
  Title: Bill Type

  Maximum Length: 15

  The bill type associated with the record type.
• Category: string
  Title: Category

  Maximum Length: 30

  The record type category.
• CitizenEnabled: string
  Title: Public User Enabled

  Maximum Length: 1

  Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.
• Classification: string
  Title: Classification

  Maximum Length: 3

  The classification of the record type.
• CloneRecordTypeCode: string
  Title: Original Permit Type Code

  The short name for a cloned record type.
• CloneReviewerDepts: string
  The record type ID for cloning plan review departments for a record type.
• CntrctrValidationGroupId: string
  Title: Contractor Validation

  Maximum Length: 50

  A unique name that identifies a contractor validation group.
• CoaReportId: string
  Title: Conditions of Approval Report ID

  Maximum Length: 32

  The Identifier for COA report.
• CoaTemplateId: string
  Title: Conditions of Approval Template

  Maximum Length: 20

  The identifier for COA template.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the record type was created.
• DepartmentId: string
  Title: Department

  Maximum Length: 30

  The department associated with the record type.
• Description: string
  Title: Description

  Maximum Length: 1000

  The long description for the record type.
• DocGroupId: string
  Title: Document Group

  Maximum Length: 30

  Indicates the document group, which is defined by a set of attachment document categories.
• ExpirationAmend: string
  Title: Allow Amendment

  Maximum Length: 1

  Default Value: N

  Indicates whether the transaction can be amended by a user. The default value is N.
• ExpirationGroupId: string
  Title: Expiration Group ID

  Maximum Length: 50

  Identifies the expiration group associated with the record type.
• ExpirationRenew: string
  Title: Allow Renewal

  Maximum Length: 1

  Default Value: N

  Indicates whether the transaction can be renewed by a user. The default value is N.
• FeeScheduleId: string
  Title: Fee Schedule

  Maximum Length: 20

  The identifier for the fee schedule associated with the record type.
• HearingOption: string
  Title: Hearing

  Maximum Length: 10

  Indicates whether a public hearing is applicable for the transaction type.
• InspectionGroup: string
  Title: Origination Inspection Group

  Maximum Length: 15

  The group of inspections if multiple inspections are required for the record type.
• InspectionGroupAmend: string
  Title: Amendment Inspection Group

  Maximum Length: 15

  The inspection group for amendments.
• InspectionGroupRenew: string
  Title: Renewal Inspection Group

  Maximum Length: 15

  The inspection group for renewals.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the record type was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MeetTemplateId: string
  Maximum Length: 30

  The identifier of the meeting template associated with the record type.
• NaicsGroupCode: string
  Title: NAICS Group

  Maximum Length: 30

  The identifier for a North American Industry Classification System (NAICS) group.
• OpaPolicyName: string
  Title: Policy

  Maximum Length: 200

  The Oracle Policy Automation template associated with the record type.
• OpaPolicyVersion: string
  Title: Policy Version

  Maximum Length: 20

  The Oracle Policy Automation policy version.
• PlanReview: string
  Title: Enable Plan Review

  Maximum Length: 10

  Indicates the type of plan review that can be created for the transaction type. The plan review type can be manual or electronic document review.
• PlanReviewTimeRuleId: string
  Title: Cycle Time Rule

  Maximum Length: 50

  The time rule identifier that is used to calculate the due date for plan review.
• RecordType: string
  Title: Permit Type

  Maximum Length: 100

  The user-friendly name for the record type.
• RecordTypeCode: string
  Title: Permit Type Code

  Maximum Length: 20

  The unique alphanumeric code or short name for the record type.
• RecordTypeId: string
  Title: Permit Type ID

  Maximum Length: 30

  The unique identifier for the record type.
• RecordTypePlanReviewerDepartment: array Record Type Plan Reviewer Departments
  Title: Record Type Plan Reviewer Departments

  The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.
• RecordTypeState: string
  Title: Permit Type Status

  Maximum Length: 10

  The status of the record type. The default value is preliminary.
• RelatedRec: array Related Record Types
  Title: Related Record Types

  The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.
• ReportControlId: string
  Title: Certificate Report ID

  Maximum Length: 32

  The identifier for the report control.
• ReportGroup: string
  Title: Report Group

  Maximum Length: 100

  The label for the report group.
• ReviewerAutoAssign: string
  Title: Enable Auto Assignment

  Maximum Length: 1

  Default Value: N

  Indicates whether a plan reviewer will be automatically assigned to the plan review. The default value is N.
• RuleId: string
  Title: Autonumber Rule

  Maximum Length: 20

  The autonumber rule used to create the identifier for record transactions.
• Subcategory: string
  Title: Subcategory

  Maximum Length: 30

  The record type subcategory.
• Subclassification: string
  Title: Subclassification

  Maximum Length: 10

  The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
• TaxClassCode: string
  Title: Tax Class

  Maximum Length: 50

  The identifier for the tax class code.
• TermsUseId: string
  Title: Terms of Use ID

  Maximum Length: 15

  The terms and use ID associated with the record type.
• TransPeriodFormat: string
  Title: License Period Format

  Maximum Length: 30

  Default Value: yyyy

  The display format for the transaction period date.
• Url: string
  Title: URL

  The URL provides a link that the user can click to navigate to other pages with more information.
• ValidFromDate: string (date)
  Title: Valid from Date

  The date when the record type is valid to use.
• ValidToDate: string (date)
  Title: Valid to Date

  The date when the record type is no longer valid to use.
• WfNoAmendFlag: string
  Title: No Amendment Workflow

  Maximum Length: 1

  Indicates that the transaction type does not contain an amendment workflow. If the value is Y, the workflow is disabled for amendment. The default value is N.
• WfNoOrigFlag: string
  Title: No Application Workflow

  Maximum Length: 1

  Indicates that the transaction type does not contain an original workflow. If the value is Y, the workflow is disabled for origination. The default value is N.
• WfNoRenewFlag: string
  Title: No Renewal Workflow

  Maximum Length: 1

  Indicates that the transaction type does not contain a renewal workflow. If the value is Y, the workflow is disabled for renewal. The default value is N.
• WfProcDefIdAmend: string
  Title: Amendment Process Name

  Maximum Length: 1000

  The workflow process definition ID used to define the workflow for an amended permit.
• WfProcDefIdOrig: string
  Title: Workflow Process Definition

  Maximum Length: 1000

  The workflow process definition ID used to define the workflow for an original permit.
• WfProcDefIdRenew: string
  Title: Renewal Process Definition

  Maximum Length: 1000

  The workflow process definition ID used to define the workflow for a renewed permit.
• WfProcVersionAmend: string
  Title: Amendment Version

  Maximum Length: 50

  The workflow project revision number used to define the workflow for an amended permit.
• WfProcVersionOrig: string
  Title: Workflow Version

  Maximum Length: 50

  The workflow project revision number used to define the workflow for an original permit.
• WfProcVersionRenew: string
  Title: Renewal Version

  Maximum Length: 50

  The workflow project revision number used to define the workflow for a renewed permit.
• WfProjectAmend: string
  Title: Amendment Application

  Maximum Length: 500

  The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.
• WfProjectOrig: string
  Title: Workflow Application ID

  Maximum Length: 500

  The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.
• WfProjectRenew: string
  Title: Renewal Application

  Maximum Length: 500

  The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.
• WfSpaceAmend: string
  Title: Amendment Space Name

  Maximum Length: 50

  The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.
• WfSpaceNameAmend: string
  Title: Amendment Space Name

  Maximum Length: 1000

  The name of the workflow space that was used to define the workflow process for an amended permit.
• WfSpaceNameOrig: string
  Title: Workflow Space Name

  Maximum Length: 1000

  The name of the workflow space that was used to define the workflow process for an original permit.
• WfSpaceNameRenew: string
  Title: Renewal Space Name

  Maximum Length: 1000

  The name of the workflow space that was used to define the workflow process for a renewed permit.
• WfSpaceOrig: string
  Title: Workflow Space Name

  Maximum Length: 50

  The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.
• WfSpaceRenew: string
  Title: Renewal Space Name

  Maximum Length: 50

  The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.

{
    "type":"object",
    "properties":{
        "Subclassification":{
            "title":"Subclassification",
            "maxLength":"10",
            "type":"string",
            "description":"The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationGroupId":{
            "title":"Expiration Group ID",
            "maxLength":"50",
            "type":"string",
            "description":"Identifies the expiration group associated with the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ExpirationAmend":{
            "title":"Allow Amendment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the transaction can be amended by a user. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "CntrctrValidationGroupId":{
            "title":"Contractor Validation",
            "maxLength":"50",
            "type":"string",
            "description":"A unique name that identifies a contractor validation group.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "RecordTypePlanReviewerDepartment":{
            "title":"Record Type Plan Reviewer Departments",
            "type":"array",
            "description":"The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-response"
            }
        },
        "WfSpaceNameAmend":{
            "title":"Amendment Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the workflow space that was used to define the workflow process for an amended permit.",
            "nullable":true,
            "x-queryable":true
        },
        "ReviewerAutoAssign":{
            "title":"Enable Auto Assignment",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether a plan reviewer will be automatically assigned to the plan review. The default value is N.",
            "nullable":true,
            "default":"N",
            "x-queryable":true
        },
        "TaxClassCode":{
            "title":"Tax Class",
            "maxLength":"50",
            "type":"string",
            "description":"The identifier for the tax class code.",
            "nullable":true,
            "x-queryable":true
        },
        "WfProjectAmend":{
            "title":"Amendment Application",
            "maxLength":"500",
            "type":"string",
            "description":"The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.",
            "nullable":true,
            "x-queryable":true
        },
        "PlanReviewTimeRuleId":{
            "title":"Cycle Time Rule",
            "maxLength":"50",
            "type":"string",
            "description":"The time rule identifier that is used to calculate the due date for plan review.",
            "nullable":true,
            "x-queryable":true
        },
        "Classification":{
            "title":"Classification",
            "maxLength":"3",
            "type":"string",
            "description":"The classification of the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "OpaPolicyVersion":{
            "title":"Policy Version",
            "maxLength":"20",
            "type":"string",
            "description":"The Oracle Policy Automation policy version.",
            "nullable":true,
            "x-queryable":true
        },
        "WfSpaceNameRenew":{
            "title":"Renewal Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the workflow space that was used to define the workflow process for a renewed permit.",
            "nullable":true,
            "x-queryable":true
        },
        "TransPeriodFormat":{
            "title":"License Period Format",
            "maxLength":"30",
            "type":"string",
            "description":"The display format for the transaction period date.",
            "nullable":true,
            "default":"yyyy",
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FeeScheduleId":{
            "title":"Fee Schedule",
            "maxLength":"20",
            "type":"string",
            "description":"The identifier for the fee schedule associated with the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionGroupAmend":{
            "title":"Amendment Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The inspection group for amendments.",
            "nullable":true,
            "x-queryable":true
        },
        "ValidToDate":{
            "title":"Valid to Date",
            "type":"string",
            "description":"The date when the record type is no longer valid to use.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "WfProjectRenew":{
            "title":"Renewal Application",
            "maxLength":"500",
            "type":"string",
            "description":"The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.",
            "nullable":true,
            "x-queryable":true
        },
        "WfSpaceAmend":{
            "title":"Amendment Space Name",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionGroupRenew":{
            "title":"Renewal Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The inspection group for renewals.",
            "nullable":true,
            "x-queryable":true
        },
        "WfSpaceOrig":{
            "title":"Workflow Space Name",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.",
            "nullable":true,
            "x-queryable":true
        },
        "ActivityGroupId":{
            "title":"Activity Group",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for the group ID for license activity.",
            "nullable":true,
            "x-queryable":true
        },
        "ApplGroup":{
            "title":"Permit Group",
            "maxLength":"30",
            "type":"string",
            "description":"The highest level of categorization to which the record type belongs.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "ValidFromDate":{
            "title":"Valid from Date",
            "type":"string",
            "description":"The date when the record type is valid to use.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "WfProjectOrig":{
            "title":"Workflow Application ID",
            "maxLength":"500",
            "type":"string",
            "description":"The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.",
            "nullable":true,
            "x-queryable":true
        },
        "DocGroupId":{
            "title":"Document Group",
            "maxLength":"30",
            "type":"string",
            "description":"Indicates the document group, which is defined by a set of attachment document categories.",
            "nullable":true,
            "x-queryable":true
        },
        "WfProcVersionOrig":{
            "title":"Workflow Version",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow project revision number used to define the workflow for an original permit.",
            "nullable":true,
            "x-queryable":true
        },
        "WfProcDefIdAmend":{
            "title":"Amendment Process Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition ID used to define the workflow for an amended permit.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportControlId":{
            "title":"Certificate Report ID",
            "maxLength":"32",
            "type":"string",
            "description":"The identifier for the report control.",
            "nullable":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"The record type category.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":"1000",
            "type":"string",
            "description":"The long description for the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for a public sector agency associated with the record type.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "PlanReview":{
            "title":"Enable Plan Review",
            "maxLength":"10",
            "type":"string",
            "description":"Indicates the type of plan review that can be created for the transaction type. The plan review type can be manual or electronic document review.",
            "nullable":true,
            "x-queryable":true
        },
        "CloneRecordTypeCode":{
            "title":"Original Permit Type Code",
            "type":"string",
            "description":"The short name for a cloned record type.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeState":{
            "title":"Permit Type Status",
            "maxLength":"10",
            "type":"string",
            "description":"The status of the record type. The default value is preliminary.",
            "nullable":false,
            "x-queryable":true
        },
        "CitizenEnabled":{
            "title":"Public User Enabled",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleId":{
            "title":"Autonumber Rule",
            "maxLength":"20",
            "type":"string",
            "description":"The autonumber rule used to create the identifier for record transactions.",
            "nullable":false,
            "x-hints":{
                "dependencies":[
                    "Subclassification"
                ]
            },
            "x-queryable":true
        },
        "WfNoAmendFlag":{
            "title":"No Amendment Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the transaction type does not contain an amendment workflow. If the value is Y, the workflow is disabled for amendment. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "NaicsGroupCode":{
            "title":"NAICS Group",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for a North American Industry Classification System (NAICS) group.",
            "nullable":true,
            "x-queryable":true
        },
        "WfProcVersionRenew":{
            "title":"Renewal Version",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow project revision number used to define the workflow for a renewed permit.",
            "nullable":true,
            "x-queryable":true
        },
        "Url":{
            "title":"URL",
            "type":"string",
            "description":"The URL provides a link that the user can click to navigate to other pages with more information.",
            "nullable":true,
            "x-queryable":false
        },
        "WfSpaceRenew":{
            "title":"Renewal Space Name",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.",
            "nullable":true,
            "x-queryable":true
        },
        "AllowPublicUserView":{
            "title":"Allow Public User to View",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the public user has view access to the report. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "RecordTypeCode":{
            "title":"Permit Type Code",
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type.",
            "nullable":false,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "WfProcVersionAmend":{
            "title":"Amendment Version",
            "maxLength":"50",
            "type":"string",
            "description":"The workflow project revision number used to define the workflow for an amended permit.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordType":{
            "title":"Permit Type",
            "maxLength":"100",
            "type":"string",
            "description":"The user-friendly name for the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "MeetTemplateId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier of the meeting template associated with the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Permit Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type.",
            "nullable":false,
            "x-hints":{
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "HearingOption":{
            "title":"Hearing",
            "maxLength":"10",
            "type":"string",
            "description":"Indicates whether a public hearing is applicable for the transaction type.",
            "nullable":true,
            "x-queryable":true
        },
        "InspectionGroup":{
            "title":"Origination Inspection Group",
            "maxLength":"15",
            "type":"string",
            "description":"The group of inspections if multiple inspections are required for the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "TermsUseId":{
            "title":"Terms of Use ID",
            "maxLength":"15",
            "type":"string",
            "description":"The terms and use ID associated with the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "WfSpaceNameOrig":{
            "title":"Workflow Space Name",
            "maxLength":"1000",
            "type":"string",
            "description":"The name of the workflow space that was used to define the workflow process for an original permit.",
            "nullable":true,
            "x-queryable":true
        },
        "BillType":{
            "title":"Bill Type",
            "maxLength":"15",
            "type":"string",
            "description":"The bill type associated with the record type.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "Subclassification"
                ]
            },
            "x-queryable":true
        },
        "CloneReviewerDepts":{
            "type":"string",
            "description":"The record type ID for cloning plan review departments for a record type.",
            "nullable":true,
            "x-queryable":true
        },
        "CoaReportId":{
            "title":"Conditions of Approval Report ID",
            "maxLength":"32",
            "type":"string",
            "description":"The Identifier for COA report.",
            "nullable":true,
            "x-queryable":true
        },
        "WfProcDefIdRenew":{
            "title":"Renewal Process Definition",
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition ID used to define the workflow for a renewed permit.",
            "nullable":true,
            "x-queryable":true
        },
        "OpaPolicyName":{
            "title":"Policy",
            "maxLength":"200",
            "type":"string",
            "description":"The Oracle Policy Automation template associated with the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "WfNoRenewFlag":{
            "title":"No Renewal Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the transaction type does not contain a renewal workflow. If the value is Y, the workflow is disabled for renewal. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "CoaTemplateId":{
            "title":"Conditions of Approval Template",
            "maxLength":"20",
            "type":"string",
            "description":"The identifier for COA template.",
            "nullable":true,
            "x-queryable":true
        },
        "ReportGroup":{
            "title":"Report Group",
            "maxLength":"100",
            "type":"string",
            "description":"The label for the report group.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationRenew":{
            "title":"Allow Renewal",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates whether the transaction can be renewed by a user. The default value is N.",
            "nullable":false,
            "default":"N",
            "x-queryable":true
        },
        "RelatedRec":{
            "title":"Related Record Types",
            "type":"array",
            "description":"The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.",
            "items":{
                "$ref":"#/components/schemas/publicSectorRecordTypes-RelatedRec-item-response"
            }
        },
        "Subcategory":{
            "title":"Subcategory",
            "maxLength":"30",
            "type":"string",
            "description":"The record type subcategory.",
            "nullable":true,
            "x-hints":{
                "promptField":"Y",
                "promptList":"Y"
            },
            "x-queryable":true
        },
        "WfNoOrigFlag":{
            "title":"No Application Workflow",
            "maxLength":"1",
            "type":"string",
            "description":"Indicates that the transaction type does not contain an original workflow. If the value is Y, the workflow is disabled for origination. The default value is N.",
            "nullable":true,
            "x-queryable":true
        },
        "WfProcDefIdOrig":{
            "title":"Workflow Process Definition",
            "maxLength":"1000",
            "type":"string",
            "description":"The workflow process definition ID used to define the workflow for an original permit.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Department",
            "maxLength":"30",
            "type":"string",
            "description":"The department associated with the record type.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the record type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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 : Record Type Plan Reviewer Departments

Type: array

Title: Record Type Plan Reviewer Departments

The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.

Show Source

• Array of: object publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-response

{
    "title":"Record Type Plan Reviewer Departments",
    "type":"array",
    "description":"The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-response"
    }
}

Nested Schema : Related Record Types

Type: array

Title: Related Record Types

The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.

Show Source

• Array of: object publicSectorRecordTypes-RelatedRec-item-response

{
    "title":"Related Record Types",
    "type":"array",
    "description":"The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.",
    "items":{
        "$ref":"#/components/schemas/publicSectorRecordTypes-RelatedRec-item-response"
    }
}

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."
        }
    }
}

Nested Schema : publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-response

Type: object

Show Source

• AgencyId: integer (int32)
  The identifier for the public sector agency associated with the record type plan reviewer departments.
• Department: string
  Read Only: true

  Maximum Length: 25

  The short description of the plan reviewer department identifier.
• DepartmentEnabled: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether the plan reviewer department is enabled.
• DepartmentId: string
  Title: Plan Reviewer Department

  Maximum Length: 30

  The identifier for record type plan reviewer departments.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordTypeCode: string
  Maximum Length: 20

  The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments.
• RecordTypeId: string
  Maximum Length: 30

  The identifier for the record type associated with the record type plan reviewer departments.
• RequiredFlag: boolean
  Title: Required Department

  Maximum Length: 1

  Indicates whether the department is required to review the documents.
• TimeRuleDescription: string
  Read Only: true

  Maximum Length: 256

  The time rule description.
• TimeRuleId: string
  Maximum Length: 50

  The time rule identifier that is used to calculate the due date.

{
    "type":"object",
    "properties":{
        "Department":{
            "maxLength":"25",
            "type":"string",
            "description":"The short description of the plan reviewer department identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DepartmentEnabled":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the plan reviewer department is enabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RecordTypeCode":{
            "maxLength":"20",
            "type":"string",
            "description":"The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the record type plan reviewer departments.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":"8"
            },
            "x-queryable":true
        },
        "TimeRuleId":{
            "maxLength":"50",
            "type":"string",
            "description":"The time rule identifier that is used to calculate the due date.",
            "nullable":true,
            "x-queryable":true
        },
        "RecordTypeId":{
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for the record type associated with the record type plan reviewer departments.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "title":"Required Department",
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates whether the department is required to review the documents.",
            "nullable":true,
            "x-queryable":true
        },
        "DepartmentId":{
            "title":"Plan Reviewer Department",
            "maxLength":"30",
            "type":"string",
            "description":"The identifier for record type plan reviewer departments.",
            "nullable":false,
            "x-queryable":true
        },
        "TimeRuleDescription":{
            "maxLength":"256",
            "type":"string",
            "description":"The time rule description.",
            "nullable":true,
            "readOnly":true,
            "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 : publicSectorRecordTypes-RelatedRec-item-response

Type: object

Show Source

• AgencyId: integer
  Title: Agency ID

  Default Value: 1

  The identifier for the public sector agency associated with the related record type.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the related record type.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date when the related record type was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date when the related record type was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the related record type.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RecordTypeId: string
  Title: Record Type ID

  Maximum Length: 30

  The unique identifier for the record type.
• RelatedTypeId: string
  Title: Related Record Type ID

  Maximum Length: 30

  The unique identifier for the related record type.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who last updated the related record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the related record type was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":"64",
            "type":"string",
            "description":"The user who created the related record type.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AgencyId":{
            "title":"Agency ID",
            "type":"integer",
            "description":"The identifier for the public sector agency associated with the related record type.",
            "nullable":false,
            "default":"1",
            "x-queryable":true
        },
        "RecordTypeId":{
            "title":"Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the record type.",
            "nullable":false,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RelatedTypeId":{
            "title":"Related Record Type ID",
            "maxLength":"30",
            "type":"string",
            "description":"The unique identifier for the related record type.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date when the related record type was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "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"
    }
}

Links

RecordTypePlanReviewerDepartment

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RecordTypePlanReviewerDepartment

Parameters:

• RecordTypeId: $request.path.RecordTypeId

The record type plan reviewer departments resource is used to view, create, modify, or delete a plan reviewer department associated with a record type. Plan reviewer departments are used for plan reviews.

RelatedRec

Operation: /fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}/child/RelatedRec

Parameters:

• RecordTypeId: $request.path.RecordTypeId

The related record types resource is used to view, create, modify, or delete a related record type. Related record types are record types that are associated with a main record type.

Back to Top