Get all record types
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes
Request
Query Parameters
-
dependency: string
This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the attributes will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency attributes. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
-
fields: string
This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource attributes. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
Format: ?fields=Attribute1,Attribute2
Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2 -
finder: string
Used as a predefined finder to search the collection.
Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
The following are the available finder names and corresponding finder variables:- 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. Finder Variables:
- RecordTypeId; string; The unique identifier for the record type.
- simpleSearchFinder: Finds a record type using the specified keyword. Finder Variables:
-
limit: integer
This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
-
offset: integer
Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
This parameter orders a resource collection based on the specified attributes. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
-
q: string
This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
Format: ?q=expression1;expression2 -
totalResults: boolean
The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Response
Supported Media Types
- application/vnd.oracle.adf.resourcecollection+json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecordTypes
Type:
Show Source
object
-
count(optional):
integer
Title:
Count
The number of resource instances returned in the current range. -
hasMore(optional):
boolean
Title:
HasMore
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false. -
items(optional):
array Items
Title:
Items
The items in the collection. -
limit(optional):
integer
Title:
Limit
The actual paging size used by the server. -
links(optional):
array Items
Title:
Items
The link relations associated with the resource instance. -
offset(optional):
integer
Title:
Offset
The offset value used in the current page.
Nested Schema : Items
Type:
array
Title:
Items
The link relations associated with the resource instance.
Show Source
Nested Schema : publicSectorRecordTypes-item
Type:
Show Source
object
-
ActivityGroupId(optional):
string
Maximum Length:
30
The identifier for the group ID for license activity. -
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for a public sector agency associated with the record type. -
AllowPublicUserView(optional):
string
Title:
Allow Public User to View
Maximum Length:1
Indicates whether the public user has view access to the report. The default value is N. -
ApplGroup(optional):
string
Maximum Length:
30
The highest level of categorization to which the record type belongs. -
BillType(optional):
string
Title:
Bill Type
Maximum Length:15
The bill type associated with the record type. -
Category(optional):
string
Maximum Length:
30
The record type category. -
CitizenEnabled(optional):
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(optional):
string
Title:
Classification
Maximum Length:3
The classification of the record type. -
CloneRecordTypeCode(optional):
string
Title:
Original Permit Type Code
The short name for a cloned record type. -
CloneReviewerDepts(optional):
string
The record type ID for cloning plan review departments for a record type.
-
CoaReportId(optional):
string
Maximum Length:
32
The Identifier for COA report. -
CoaTemplateId(optional):
string
Maximum Length:
20
The identifier for COA template. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the record type. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the record type was created. -
DepartmentId(optional):
string
Title:
Department
Maximum Length:30
The department associated with the record type. -
Description(optional):
string
Title:
Description
Maximum Length:1000
The long description for the record type. -
DocGroupId(optional):
string
Title:
Document Group
Maximum Length:30
Indicates the document group, which is defined by a set of attachment document categories. -
ExpirationAmend(optional):
string
Title:
Allow Amendment
Maximum Length:1
Indicates whether the transaction can be amended by a user. The default value is N. -
ExpirationGroupId(optional):
string
Title:
Expiration Group ID
Maximum Length:50
Identifies the expiration group associated with the record type. -
ExpirationRenew(optional):
string
Title:
Allow Renewal
Maximum Length:1
Indicates whether the transaction can be renewed by a user. The default value is N. -
FeeScheduleId(optional):
string
Maximum Length:
20
The identifier for the fee schedule associated with the record type. -
FormDesignStatus(optional):
string
Maximum Length:
9
Indicates to show the status of design form layout, either draft or published, for each transaction type. -
HearingOption(optional):
string
Title:
Hearing
Maximum Length:10
Indicates whether a public hearing is applicable for the transaction type. -
InspectionGroup(optional):
string
Maximum Length:
15
The group of inspections if multiple inspections are required for the record type. -
IsClonable(optional):
string
Maximum Length:
1
The identifier to confirm if cloning is allowed. If the value is Y, then this record type can be cloned. If the value is N, then this record type can't be cloned. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the record type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the record type. -
links(optional):
array Items
Title:
Items
Link Relations -
NaicsGroupCode(optional):
string
Title:
NAICS Group
Maximum Length:30
The identifier for a North American Industry Classification System (NAICS) group. -
OpaPolicyName(optional):
string
Title:
Policy
Maximum Length:200
The Oracle Policy Automation template associated with the record type. -
OpaPolicyVersion(optional):
string
Title:
Policy Version
Maximum Length:20
The Oracle Policy Automation policy version. -
PlanReview(optional):
string
Title:
Plan Review Type
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. -
RecordType(optional):
string
Title:
Permit Type
Maximum Length:100
The user-friendly name for the record type. -
RecordTypeCode(optional):
string
Title:
Permit Type Code
Maximum Length:20
The unique alphanumeric code or short name for the record type. -
RecordTypeId(optional):
string
Title:
Permit Type ID
Maximum Length:30
The unique identifier for the record type. -
RecordTypePlanReviewerDepartment(optional):
array Record Type Plan Reviewer Departments
Title:
Record Type Plan Reviewer Departments
The record type resource is used to view, create, modify, or delete a record type. A record type establishes the types of applications supported by an agency. -
RecordTypeState(optional):
string
Title:
Permit Type Status
Maximum Length:10
The status of the record type. The default value is preliminary. -
RelatedRec(optional):
array Related Record Types
Title:
Related Record Types
The record type resource is used to view, create, modify, or delete a record type. A record type establishes the types of applications supported by an agency. -
ReportControlId(optional):
string
Title:
Certificate Report ID
Maximum Length:32
The identifier for the report control. -
ReviewerAutoAssign(optional):
string
Title:
Enable Auto Assignment
Maximum Length:1
Indicates whether a plan reviewer will be automatically assigned to the plan review. The default value is N. -
RuleId(optional):
string
Maximum Length:
20
The autonumber rule used to create the identifier for record transactions. -
Subcategory(optional):
string
Maximum Length:
30
The record type subcategory. -
Subclassification(optional):
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(optional):
string
Title:
Tax Class
Maximum Length:50
The identifier for the tax class code. -
TermsUseId(optional):
string
Title:
Terms of Use ID
Maximum Length:15
The terms and use ID associated with the record type. -
TransPeriodFormat(optional):
string
Maximum Length:
30
The display format for the transaction period date. -
Url(optional):
string
Title:
URL
The URL provides a link that the user can click to navigate to other pages with more information. -
ValidFromDate(optional):
string(date-time)
Title:
Valid from Date
The date when the record type is valid to use. -
ValidToDate(optional):
string(date-time)
Title:
Valid to Date
The date when the record type is no longer valid to use. -
WfProcDefIdAmend(optional):
string
Title:
Amendment Process Name
Maximum Length:1000
The workflow process definition ID used to define the workflow for an amended permit. -
WfProcDefIdOrig(optional):
string
Title:
Workflow Process Definition
Maximum Length:1000
The workflow process definition ID used to define the workflow for an original permit. -
WfProcDefIdRenew(optional):
string
Title:
Renewal Process Definition
Maximum Length:1000
The workflow process definition ID used to define the workflow for a renewed permit. -
WfProcVersionAmend(optional):
string
Title:
Amendment Version
Maximum Length:50
The workflow project revision number used to define the workflow for an amended permit. -
WfProcVersionOrig(optional):
string
Title:
Workflow Version
Maximum Length:50
The workflow project revision number used to define the workflow for an original permit. -
WfProcVersionRenew(optional):
string
Title:
Renewal Version
Maximum Length:50
The workflow project revision number used to define the workflow for a renewed permit. -
WfProjectAmend(optional):
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(optional):
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(optional):
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(optional):
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(optional):
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(optional):
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(optional):
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(optional):
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(optional):
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 : Record Type Plan Reviewer Departments
Type:
array
Title:
Record Type Plan Reviewer Departments
The record type resource is used to view, create, modify, or delete a record type. A record type establishes the types of applications supported by an agency.
Show Source
Nested Schema : Related Record Types
Type:
array
Title:
Related Record Types
The record type resource is used to view, create, modify, or delete a record type. A record type establishes the types of applications supported by an agency.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href(optional):
string
Title:
hyperlink reference
The URI to the related resource. -
rel(optional):
string
Title:
relation
The name of the relation to the resource instance. Example: self.
Nested Schema : publicSectorRecordTypes-RecordTypePlanReviewerDepartment-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier for the public sector agency associated with the record type plan reviewer departments.
-
DepartmentId(optional):
string
Maximum Length:
30
The identifier for record type plan reviewer departments. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordTypeCode(optional):
string
Maximum Length:
20
The unique alphanumeric code or short name for the record type associated with the record type plan reviewer departments. -
RecordTypeId(optional):
string
Maximum Length:
30
The identifier for the record type associated with the record type plan reviewer departments.
Nested Schema : publicSectorRecordTypes-RelatedRec-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with the related record type. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the related record type. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the related record type was created. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the related record type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The user who last updated the related record type. -
links(optional):
array Items
Title:
Items
Link Relations -
RecordTypeId(optional):
string
Title:
Record Type ID
Maximum Length:30
The unique identifier for the record type. -
RelatedTypeId(optional):
string
Title:
Related Record Type ID
Maximum Length:30
The unique identifier for the related record type.