Update an inspection checklist
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{InspectionChklistKey}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
InspectionChklistKey: integer
The unique identifier for an inspection checklist.
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInspectionChkLists-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with the inspection checklist. -
AssessmentType(optional):
string
Title:
Assessment Type
Maximum Length:15
The name of the assessment type used for the inspection checklist from the checklist setup table. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistName(optional):
string
Title:
Checklist Name
Maximum Length:100
The description of an inspection checklist from the checklist setup table. -
ChecklistResult(optional):
string
Title:
Result
Maximum Length:15
The result for this checklist, such as Pass, Fail, Yes, No, and so on. -
ChecklistScore(optional):
integer(int32)
Title:
Score
The calculated score for this checklist. -
CommonComment(optional):
string
Title:
Comment
Maximum Length:1000
The comments for a specific inspection checklist from the checklist setup table. -
InspectionChklistKey(optional):
integer(int64)
The unique identifier for an inspection checklist.
-
InspectionChklistPuid(optional):
string
Maximum Length:
480
The persistent unique identifier for an inspection checklist. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
The unique identifier for an inspection. -
InspectionKey(optional):
integer(int64)
The unique identifier for an inspection.
-
InspectionPuid(optional):
string
Maximum Length:
480
The persistent unique identifier for an inspection. -
links(optional):
array Items
Title:
Items
Link Relations -
MajorViolationFlag(optional):
boolean
Title:
Major Violation
Indicates whether a failing result for the checklist constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. The information is copied from the checklist setup table. -
MaximumScore(optional):
integer(int32)
Title:
Maximum Score
The maximum score possible for an inspection checklist from the checklist setup table. -
MinimumPassingScore(optional):
integer(int32)
Title:
Minimum Passing Score
The minimum checklist score that is considered a passing result from the checklist setup table. -
NumberMajorViolations(optional):
integer(int32)
The calculated number of major violations for the checklist.
-
PossibleScore(optional):
integer(int32)
Title:
Possible Score
The possible score that the checklist item can receive from the checklist setup table. -
RequiredFlag(optional):
boolean
Title:
Required
Indicates whether this inspection checklist item is required. The default value is true. The information is from the checklist setup table. -
ScoringMethod(optional):
string
Title:
Score Method
Maximum Length:15
The method used for scoring a checklist from the checklist setup table. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.
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 : publicSectorInspectionChkLists-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with the inspection checklist. -
AssessmentType(optional):
string
Title:
Assessment Type
Maximum Length:15
The name of the assessment type used for the inspection checklist from the checklist setup table. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistName(optional):
string
Title:
Checklist Name
Maximum Length:100
The description of an inspection checklist from the checklist setup table. -
ChecklistResult(optional):
string
Title:
Result
Maximum Length:15
The result for this checklist, such as Pass, Fail, Yes, No, and so on. -
ChecklistScore(optional):
integer(int32)
Title:
Score
The calculated score for this checklist. -
CommonComment(optional):
string
Title:
Comment
Maximum Length:1000
The comments for a specific inspection checklist from the checklist setup table. -
InspectionChklistKey(optional):
integer(int64)
The unique identifier for an inspection checklist.
-
InspectionChklistPuid(optional):
string
Maximum Length:
480
The persistent unique identifier for an inspection checklist. -
InspectionId(optional):
string
Title:
Inspection
Maximum Length:50
The unique identifier for an inspection. -
InspectionKey(optional):
integer(int64)
The unique identifier for an inspection.
-
InspectionPuid(optional):
string
Maximum Length:
480
The persistent unique identifier for an inspection. -
links(optional):
array Items
Title:
Items
Link Relations -
MajorViolationFlag(optional):
boolean
Title:
Major Violation
Indicates whether a failing result for the checklist constitutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. The information is copied from the checklist setup table. -
MaximumScore(optional):
integer(int32)
Title:
Maximum Score
The maximum score possible for an inspection checklist from the checklist setup table. -
MinimumPassingScore(optional):
integer(int32)
Title:
Minimum Passing Score
The minimum checklist score that is considered a passing result from the checklist setup table. -
NumberMajorViolations(optional):
integer(int32)
The calculated number of major violations for the checklist.
-
PossibleScore(optional):
integer(int32)
Title:
Possible Score
The possible score that the checklist item can receive from the checklist setup table. -
RequiredFlag(optional):
boolean
Title:
Required
Indicates whether this inspection checklist item is required. The default value is true. The information is from the checklist setup table. -
ScoringMethod(optional):
string
Title:
Score Method
Maximum Length:15
The method used for scoring a checklist from the checklist setup table. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.
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.