Update an inspection checklist
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkLists/{publicSectorInspectionChkListsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorInspectionChkListsUniqID: integer
This is the hash key of the attributes which make up the composite key--- InspectionId, ChecklistId and AgencyId ---for the Inspection Checklists resource and used to uniquely identify an instance of Inspection Checklists. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklists collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklists.
For example: publicSectorInspectionChkLists?q=InspectionId=<value1>;ChecklistId=<value2>;AgencyId=<value3>
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 IDThe identifier for the public sector agency associated with the inspection checklist. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type used for the inspection checklist from the checklist setup table. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistName(optional):
string
Title:
Checklist NameMaximum Length:100The description of an inspection checklist from the checklist setup table. -
ChecklistResult(optional):
string
Title:
ResultMaximum Length:15The result for this checklist, such as Pass, Fail, Yes, No, and so on. -
ChecklistScore(optional):
integer(int32)
Title:
ScoreThe calculated score for this checklist. -
CommonComment(optional):
string
Title:
CommentMaximum Length:1000The comments for a specific inspection checklist from the checklist setup table. -
InspectionId(optional):
string
Title:
InspectionMaximum Length:50The unique identifier for an inspection. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates 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 ScoreThe maximum score possible for an inspection checklist from the checklist setup table. -
MinimumPassingScore(optional):
integer(int32)
Title:
Minimum Passing ScoreThe 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 ScoreThe possible score that the checklist item can receive from the checklist setup table. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates 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 MethodMaximum Length:15The 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 referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe 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 IDThe identifier for the public sector agency associated with the inspection checklist. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type used for the inspection checklist from the checklist setup table. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistName(optional):
string
Title:
Checklist NameMaximum Length:100The description of an inspection checklist from the checklist setup table. -
ChecklistResult(optional):
string
Title:
ResultMaximum Length:15The result for this checklist, such as Pass, Fail, Yes, No, and so on. -
ChecklistScore(optional):
integer(int32)
Title:
ScoreThe calculated score for this checklist. -
CommonComment(optional):
string
Title:
CommentMaximum Length:1000The comments for a specific inspection checklist from the checklist setup table. -
InspectionId(optional):
string
Title:
InspectionMaximum Length:50The unique identifier for an inspection. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates 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 ScoreThe maximum score possible for an inspection checklist from the checklist setup table. -
MinimumPassingScore(optional):
integer(int32)
Title:
Minimum Passing ScoreThe 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 ScoreThe possible score that the checklist item can receive from the checklist setup table. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates 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 MethodMaximum Length:15The 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 referenceThe URI to the related resource. -
rel(optional):
string
Title:
relationThe name of the relation to the resource instance. Example: self.