Update a record type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypes/{RecordTypeId}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
RecordTypeId: string
The unique identifier for the record type.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorRecordTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for a public sector agency associated with the record type. -
AllowPublicUserView(optional):
string
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.
-
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
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
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. -
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. -
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
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
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. -
TermsUseId(optional):
string
Title:
Terms of Use ID
Maximum Length:15
The terms and use ID associated with the record type. -
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
Maximum Length:
1000
The name of the workflow space that was used to define the workflow process for an amended permit. -
WfSpaceNameOrig(optional):
string
Maximum Length:
1000
The name of the workflow space that was used to define the workflow process for an original permit. -
WfSpaceNameRenew(optional):
string
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.
Response
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Default Response
The following table describes the default response for this task.
Root Schema : publicSectorRecordTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for a public sector agency associated with the record type. -
AllowPublicUserView(optional):
string
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.
-
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
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
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. -
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. -
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
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
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. -
TermsUseId(optional):
string
Title:
Terms of Use ID
Maximum Length:15
The terms and use ID associated with the record type. -
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
Maximum Length:
1000
The name of the workflow space that was used to define the workflow process for an amended permit. -
WfSpaceNameOrig(optional):
string
Maximum Length:
1000
The name of the workflow space that was used to define the workflow process for an original permit. -
WfSpaceNameRenew(optional):
string
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.