Get all record types
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes
Request
Query Parameters
-
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- PrimaryKey: Finds the record type that matches the specified primary key criteria.
Finder Variables:- RecordTypeId; string; The unique identifier for the record type.
- simpleSearchFinder: Finds a record type using the specified keyword.
Finder Variables:- value; string; The keyword used to find a record type by matching with a record type, application group, application category, or application subcategory.
- PrimaryKey: Finds the record type that matches the specified primary key criteria.
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
links: string
This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
Example:
self,canonical -
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2
You can use these queryable attributes to filter this collection resource using the q query parameter:- ActivityGroupId; string; The identifier for the group ID for license activity.
- AgencyId; integer; The identifier for a public sector agency associated with the record type.
- AllowPublicUserView; string; Indicates whether the public user has view access to the report. The default value is N.
- ApplGroup; string; The highest level of categorization to which the record type belongs.
- BillType; string; The bill type associated with the record type.
- Category; string; The record type category.
- CitizenEnabled; string; Indicates whether public users can submit an application form with this record type. The default value is not enabled for public users.
- Classification; string; The classification of the record type.
- CloneRecordTypeCode; string; 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; A unique name that identifies a contractor validation group.
- CoaReportId; string; The Identifier for COA report.
- CoaTemplateId; string; The identifier for COA template.
- CreationDate; string; The date when the record type was created.
- DepartmentId; string; The department associated with the record type.
- Description; string; The long description for the record type.
- DocGroupId; string; Indicates the document group, which is defined by a set of attachment document categories.
- ExpirationAmend; string; Indicates whether the transaction can be amended by a user. The default value is N.
- ExpirationGroupId; string; Identifies the expiration group associated with the record type.
- ExpirationRenew; string; Indicates whether the transaction can be renewed by a user. The default value is N.
- FeeScheduleId; string; The identifier for the fee schedule associated with the record type.
- HearingOption; string; Indicates whether a public hearing is applicable for the transaction type.
- InspectionGroup; string; The group of inspections if multiple inspections are required for the record type.
- InspectionGroupAmend; string; The inspection group for amendments.
- InspectionGroupRenew; string; The inspection group for renewals.
- LastUpdateDate; string; The date when the record type was last updated.
- MeetTemplateId; string; The identifier of the meeting template associated with the record type.
- NaicsGroupCode; string; The identifier for a North American Industry Classification System (NAICS) group.
- OpaPolicyName; string; The Oracle Policy Automation template associated with the record type.
- OpaPolicyVersion; string; The Oracle Policy Automation policy version.
- PlanReview; string; 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; The time rule identifier that is used to calculate the due date for plan review.
- RecordType; string; The user-friendly name for the record type.
- RecordTypeCode; string; The unique alphanumeric code or short name for the record type.
- RecordTypeId; string; The unique identifier for the record type.
- RecordTypeState; string; The status of the record type. The default value is preliminary.
- ReportControlId; string; The identifier for the report control.
- ReportGroup; string; The label for the report group.
- ReviewerAutoAssign; string; Indicates whether a plan reviewer will be automatically assigned to the plan review. The default value is N.
- RuleId; string; The autonumber rule used to create the identifier for record transactions.
- Subcategory; string; The record type subcategory.
- Subclassification; string; The subclassification for the transaction type, which indicates that the pre-application process is included in addition to the hearing process.
- TaxClassCode; string; The identifier for the tax class code.
- TermsUseId; string; The terms and use ID associated with the record type.
- TransPeriodFormat; string; The display format for the transaction period date.
- ValidFromDate; string; The date when the record type is valid to use.
- ValidToDate; string; The date when the record type is no longer valid to use.
- WfNoAmendFlag; string; 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; 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; 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; The workflow process definition ID used to define the workflow for an amended permit.
- WfProcDefIdOrig; string; The workflow process definition ID used to define the workflow for an original permit.
- WfProcDefIdRenew; string; The workflow process definition ID used to define the workflow for a renewed permit.
- WfProcVersionAmend; string; The workflow project revision number used to define the workflow for an amended permit.
- WfProcVersionOrig; string; The workflow project revision number used to define the workflow for an original permit.
- WfProcVersionRenew; string; The workflow project revision number used to define the workflow for a renewed permit.
- WfProjectAmend; string; The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.
- WfProjectOrig; string; The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.
- WfProjectRenew; string; The workflow application created in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.
- WfSpaceAmend; string; The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an amended permit.
- WfSpaceNameAmend; string; The name of the workflow space that was used to define the workflow process for an amended permit.
- WfSpaceNameOrig; string; The name of the workflow space that was used to define the workflow process for an original permit.
- WfSpaceNameRenew; string; The name of the workflow space that was used to define the workflow process for a renewed permit.
- WfSpaceOrig; string; The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for an original permit.
- WfSpaceRenew; string; The workflow space ID in Oracle Autonomous Integration Cloud used to define the workflow process for a renewed permit.
-
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version(required):
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : publicSectorRecordTypes
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordTypes-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
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
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
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Nested Schema : publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordTypes-RelatedRec-item-response
Type:
Show Source
object
-
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.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source