Get a record type
get
/fscmRestApi/resources/11.13.18.05/publicSectorRecordTypePrompts/{RecordTypeId}
Request
Path Parameters
-
RecordTypeId: string
The unique identifier of the Permit, Planning application, or Business License application type.
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : publicSectorRecordTypePrompts-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int32)
The identifier of the agency.
-
ApplGroup(optional):
string
Maximum Length:
30
The application group of the permit, planning application, or business license type. -
BillType(optional):
string
Maximum Length:
15
The bill type for the permit, planning application, or business license type. -
Category(optional):
string
Maximum Length:
30
The category of the permit, planning application, or business license type. -
CitizenEnabled(optional):
string
Maximum Length:
1
A flag to determine whether permit, planning application, or business license type is enabled for public users. -
Classification(optional):
string
Title:
Classification
Maximum Length:3
The classification of record type like PMT, PZ or LIC. -
DepartmentId(optional):
string
Maximum Length:
30
The department of the permit, planning application, or business license type. -
DocGroupId(optional):
string
Maximum Length:
30
The document group of the permit, planning application, or business license type. -
FeeScheduleId(optional):
string
Maximum Length:
20
The fee schedule of the permit, planning application, or business license type. -
HearingOption(optional):
string
Maximum Length:
10
A flag to determine whether Hearing is enabled for the pre-application type. -
InspectionGroup(optional):
string
Maximum Length:
15
The inspection group of the permit, planning application, or business license type. -
links(optional):
array Items
Title:
Items
Link Relations -
Meaning(optional):
string
Maximum Length:
80
The description of permit, planning application, or business license type. -
PlanReview(optional):
string
Maximum Length:
10
The plan review type of the permit, planning application, or business license type. -
RecordType(optional):
string
Title:
Record Type
Maximum Length:100
The name of the permit, planning application, or business license application type. -
RecordTypeCode(optional):
string
Title:
Original Permit Type Code
Maximum Length:20
The code of the permit, planning application, or business license application type. -
RecordTypeId(optional):
string
Title:
Record Type ID
Maximum Length:30
The unique identifier of the Permit, Planning application, or Business License application type. -
RecordTypeState(optional):
string
Maximum Length:
10
The status of the permit, planning application, or business license application type such as Preliminary, Ready, or Void. -
RenewalRuleId(optional):
string
Maximum Length:
20
The renewal rule defined for the permit, planning application, or business license application type. -
RuleId(optional):
string
Maximum Length:
20
The autonumber rule defined for the permit, planning application, or business license application type. -
Subcategory(optional):
string
Maximum Length:
30
The subcategory of the permit, planning application, or business license type. -
Subclassification(optional):
string
Maximum Length:
10
The subclassification of the record type such as Pre-Application or Consultation. -
TermsUseId(optional):
string
Maximum Length:
15
The terms of use defined for the permit, planning application, or business license type. -
ValidFromDate(optional):
string(date)
The valid from date of the permit, planning application, or business license type.
-
ValidToDate(optional):
string(date)
The valid to date of the permit, planning application, or business license type.
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.