Update an inspection type
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionTypes/{publicSectorInspectionTypesUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorInspectionTypesUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and InspectionType ---for the Inspection Types resource and used to uniquely identify an instance of Inspection Types. The client should not generate the hash key value. Instead, the client should query on the Inspection Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Types.
For example: publicSectorInspectionTypes?q=AgencyId=<value1>;InspectionType=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInspectionTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
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(optional):
string
Title:
Assessment Type
Maximum Length:15
The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results. -
AutonumberRuleId(optional):
string
Title:
Autonumber Rule
Maximum Length:20
The unique identifier for an autonumber rule that is used for generating the inspection transaction key. -
BillableFlag(optional):
boolean
Title:
Billable
Indicates whether the inspection is a billable transaction. The default is no. -
BillType(optional):
string
Title:
Bill Type
Maximum Length:15
The type of invoice that is generated for the inspection transaction. -
ChangeSchedulePolicyHrs(optional):
integer(int32)
Title:
Schedule Change Policy
The number of hours prior to the scheduled inspection time that a user can still submit a request to cancel or reschedule an inspection. -
ChecklistGroup(optional):
string
Title:
Checklist Group
Maximum Length:15
The identifier for a collection of inspection checklists. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The identifier for an inspection checklist. -
ContractorSignatureOpt(optional):
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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the inspection type. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the inspection type was created. -
Description(optional):
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(optional):
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(optional):
boolean
Title:
Enabled
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(optional):
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. -
HideInspectorComment(optional):
boolean
Title:
Hide Inspector Comments
Indicates whether inspector comments will be hidden from public users. The default is no. -
InspectionType(optional):
string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection. -
InspectorSignatureOpt(optional):
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(optional):
string(date-time)
Title:
Last Updated Date
The date when the inspection type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The session login associated with the user who last updated the inspection type. -
links(optional):
array Items
Title:
Items
Link Relations -
MaximumScore(optional):
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(optional):
string
Title:
Policy Name
Maximum Length:200
The name of the Oracle Policy Automation template that is associated with an inspection type. -
OpaPolicyVersion(optional):
string
Title:
Policy Version
Maximum Length:20
The version of the Oracle Policy Automation policy version that is associated with an inspection type. -
OwnerSignatureOpt(optional):
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(optional):
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(optional):
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(optional):
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(optional):
string
Title:
Scheduling Method
Maximum Length:15
The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule. -
ScoringMethod(optional):
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 : 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.
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 : publicSectorInspectionTypes-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
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(optional):
string
Title:
Assessment Type
Maximum Length:15
The unique identifier for the assessment type. The assessment type definition consists of a list of inspection assessments and their corresponding results. -
AutonumberRuleId(optional):
string
Title:
Autonumber Rule
Maximum Length:20
The unique identifier for an autonumber rule that is used for generating the inspection transaction key. -
BillableFlag(optional):
boolean
Title:
Billable
Indicates whether the inspection is a billable transaction. The default is no. -
BillType(optional):
string
Title:
Bill Type
Maximum Length:15
The type of invoice that is generated for the inspection transaction. -
ChangeSchedulePolicyHrs(optional):
integer(int32)
Title:
Schedule Change Policy
The number of hours prior to the scheduled inspection time that a user can still submit a request to cancel or reschedule an inspection. -
ChecklistGroup(optional):
string
Title:
Checklist Group
Maximum Length:15
The identifier for a collection of inspection checklists. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The identifier for an inspection checklist. -
ContractorSignatureOpt(optional):
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. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the inspection type. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the inspection type was created. -
Description(optional):
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(optional):
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(optional):
boolean
Title:
Enabled
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(optional):
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. -
HideInspectorComment(optional):
boolean
Title:
Hide Inspector Comments
Indicates whether inspector comments will be hidden from public users. The default is no. -
InspectionType(optional):
string
Title:
Inspection Type
Maximum Length:15
The unique identifier for a type of inspection. -
InspectorSignatureOpt(optional):
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(optional):
string(date-time)
Title:
Last Updated Date
The date when the inspection type was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The session login associated with the user who last updated the inspection type. -
links(optional):
array Items
Title:
Items
Link Relations -
MaximumScore(optional):
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(optional):
string
Title:
Policy Name
Maximum Length:200
The name of the Oracle Policy Automation template that is associated with an inspection type. -
OpaPolicyVersion(optional):
string
Title:
Policy Version
Maximum Length:20
The version of the Oracle Policy Automation policy version that is associated with an inspection type. -
OwnerSignatureOpt(optional):
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(optional):
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(optional):
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(optional):
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(optional):
string
Title:
Scheduling Method
Maximum Length:15
The method used for scheduling an inspection. The request method is used if a user submits a request for an inspection to be scheduled. The schedule method is used if the user selects an available time from an inspection schedule. -
ScoringMethod(optional):
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 : 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.