Get all inspection types
get
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes
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 an inspection type using the specified agency identifier and inspection type.
Finder Variables:- AgencyId; integer; The identifier for the public agency.
- InspectionType; string; The inspection type.
- simpleSearchFinder: Finds inspection type using the specified inspection type or description.
Finder Variables:- value; string; The inspection type or description.
- PrimaryKey: Finds an inspection type using the specified agency identifier and inspection type.
-
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:- AgencyId; integer; The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state.
- AssessmentType; string; The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results.
- AutonumberRuleId; string; The unique identifier for an autonumber rule that is used for generating the inspection transaction key.
- BillType; string; The type of invoice that is generated for the inspection transaction.
- BillableFlag; boolean; Indicates whether the inspection is a billable transaction. The default is no.
- ChangeSchedulePolicyHrs; integer; The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection.
- ChecklistGroup; string; The identifier for a collection of inspection checklists.
- ChecklistId; string; The identifier for an inspection checklist.
- ContractorSignatureOpt; string; Indicates whether the contractor needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.
- CreationDate; string; The date when the inspection type was created.
- Description; string; The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection.
- DistrictType; string; The type of district for the inspection. Examples of an inspection district are Building, Electrical, and Plumbing inspection.
- EnabledFlag; boolean; Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled.
- EstimatedDurationHrs; number; The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling.
- HideAssessFeeFlag; string; Indicates whether the assess fee flag is hidden when viewing inspection records.
- HideInspectorComment; boolean; Indicates whether inspector comments will be hidden from public users. The default is no.
- InspectionType; string; The unique identifier for a type of inspection.
- InspectorSignatureOpt; string; Indicates whether the inspector must sign the inspection report before the submitting the inspection in the system. Values include Optional, Required, and Not Required. The default is Required.
- LastUpdateDate; string; The date when the inspection type was last updated.
- MaximumScore; integer; The maximum inspection score that can result in the specified rating. The maximum score must be greater than the minimum score, and the score ranges for a specific rating must not overlap with the other ratings that are defined for a rating method.
- OpaPolicyName; string; The name of the Oracle Policy Automation template that is associated with an inspection type.
- OpaPolicyVersion; string; The version of the Oracle Policy Automation policy version that is associated with an inspection type.
- OwnerSignatureOpt; string; Indicates whether the property owner needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional.
- PassingRule; string; The unique identifier for a passing rule. Passing rules provide results criteria to determine whether an inspection passes or fails.
- RatingMethod; string; The unique code to identify the rating method used for an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5).
- ScheduleCutoffTime; string; The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled.
- SchedulingMethod; string; The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule.
- ScoringMethod; string; The method used for calculating the score for an inspection. For example, with the bottom up method, the inspector starts with a zero score and adds points for each criterion that is met.
-
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 : publicSectorInspectionTypes
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 : publicSectorInspectionTypes-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for a public sector agency. This is usually an alphanumeric identifier for a city, county, or state, but it can also be the name of a city, county, or state. -
AssessmentType: string
Title:
Assessment Type
Maximum Length:25
The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results. -
AutonumberRuleId: string
Title:
Autonumber Rule
Maximum Length:20
The unique identifier for an autonumber rule that is used for generating the inspection transaction key. -
BillableFlag: boolean
Title:
Billable
Maximum Length:1
Indicates whether the inspection is a billable transaction. The default is no. -
BillType: string
Title:
Bill Type
Maximum Length:15
The type of invoice that is generated for the inspection transaction. -
ChangeSchedulePolicyHrs: integer
(int32)
Title:
Schedule Change Policy
The number of hours prior to the scheduled inspection time that a user can cancel or reschedule an inspection. -
ChecklistGroup: string
Title:
Checklist Group
Maximum Length:15
The identifier for a collection of inspection checklists. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The identifier for an inspection checklist. -
ContractorSignatureOpt: string
Title:
Contractor Signature
Maximum Length:3
Indicates whether the contractor needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the inspection type was created. -
Description: string
Title:
Description
Maximum Length:100
The description of the building inspection type. For example, Electrical Inspection, Final Fence Inspection, or Final Building Inspection. -
DistrictType: string
Title:
Inspection District Type
Maximum Length:30
The type of district for the inspection. Examples of an inspection district are Building, Electrical, and Plumbing inspection. -
EnabledFlag: boolean
Title:
Enabled
Maximum Length:1
Indicates whether the inspection type is available to be used. If the inspection type is enabled, it can be used. The default is disabled. -
EstimatedDurationHrs: number
Title:
Estimated Duration in Hours
The estimated number of hours required to perform the inspection. This information can be used for planning and scheduling. -
HideAssessFeeFlag: string
Title:
Hide Assess Fee Option
Maximum Length:1
Default Value:N
Indicates whether the assess fee flag is hidden when viewing inspection records. -
HideInspectorComment: boolean
Title:
Hide Inspector Comments
Maximum Length:1
Indicates whether inspector comments will be hidden from public users. The default is no. -
InspectionType: string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection. -
InspectorSignatureOpt: string
Title:
Inspector Signature
Maximum Length:3
Indicates whether the inspector must sign the inspection report before the submitting the inspection in the system. Values include Optional, Required, and Not Required. The default is Required. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the inspection type was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MaximumScore: integer
(int32)
Title:
Maximum Score
The maximum inspection score that can result in the specified rating. The maximum score must be greater than the minimum score, and the score ranges for a specific rating must not overlap with the other ratings that are defined for a rating method. -
OpaPolicyName: string
Title:
Policy Name
Maximum Length:200
The name of the Oracle Policy Automation template that is associated with an inspection type. -
OpaPolicyVersion: string
Title:
Policy Version
Maximum Length:20
The version of the Oracle Policy Automation policy version that is associated with an inspection type. -
OwnerSignatureOpt: string
Title:
Owner Signature
Maximum Length:3
Indicates whether the property owner needs to sign the inspection report before the inspector can submit the inspection in the system. Values include Optional, Required, and Not Required. The default is Optional. -
PassingRule: string
Title:
Passing Rule
Maximum Length:15
The unique identifier for a passing rule. Passing rules provide results criteria to determine whether an inspection passes or fails. -
RatingMethod: string
Title:
Rating Method
Maximum Length:15
The unique code to identify the rating method used for an inspection result. Rating methods are used to assign ratings such as a grade (A-F) or a numerical scale (1-5). -
ScheduleCutoffTime: string
(date-time)
Title:
Schedule Cutoff Time
The time value for the latest time of day when an inspection request can be submitted, updated, deleted, or canceled. -
SchedulingMethod: string
Title:
Scheduling Method
Maximum Length:15
Default Value:SCHEDULE
The method used for scheduling an inspection. The request method is used if a user submits a preferred date and preferred time for an inspection to be scheduled. The ready method is used if a user submits a ready by date and a ready by time for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule. -
ScoringMethod: string
Title:
Scoring Method
Maximum Length:15
The method used for calculating the score for an inspection. For example, with the bottom up method, the inspector starts with a zero score and adds points for each criterion that is met.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
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.