Update an inspection checklist item
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChkListItems/{InspectionClItemKey}
Request
Path Parameters
-
InspectionClItemKey(required): integer(int64)
The unique identifier for an inspection checklist item.
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.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
ChecklistItemResult: string
Title:
Result
Maximum Length:15
The result for this checklist item, such as Pass, Fail, Yes, No, and so on. -
ChecklistItemScore: integer
(int32)
Title:
Score
The calculated score for this checklist item. -
MajorViolationFlag: boolean
Title:
Major Violation
Maximum Length:1
Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
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.
Root Schema : publicSectorInspectionChkListItems-item-response
Type:
Show Source
object
-
AgencyId: integer
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with the inspection checklist item. -
CategoryCode: string
Title:
Category
Maximum Length:30
The category of the inspection checklist item. This is copied from the checklist item setup table. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The unique identifier for the inspection checklist. -
ChecklistItemId: string
Title:
Checklist Item
Maximum Length:15
The unique identifier for the inspection checklist item. -
ChecklistItemName: string
Title:
Checklist Item Name
Maximum Length:300
The description of the inspection checklist item. This is copied from the checklist item setup table. -
ChecklistItemResult: string
Title:
Result
Maximum Length:15
The result for this checklist item, such as Pass, Fail, Yes, No, and so on. -
ChecklistItemScore: integer
(int32)
Title:
Score
The calculated score for this checklist item. -
InspectionChklistKey: integer
(int64)
The unique identifier for an inspection checklist.
-
InspectionChklistPuid: string
Maximum Length:
480
The persistent unique identifier for an inspection checklist. -
InspectionClItemKey: integer
(int64)
The unique identifier for an inspection checklist item.
-
InspectionClItemPuid: string
Maximum Length:
480
The persistent unique identifier for an inspection checklist item. -
InspectionId: string
Title:
Inspection
Maximum Length:50
The unique identifier for the inspection. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MajorViolationFlag: boolean
Title:
Major Violation
Maximum Length:1
Indicates whether a failing result for the checklist item constitutes a major violation. The value is Y or N. -
PossibleScore: integer
(int32)
Title:
Possible Score
The maximum possible score for the checklist item. This is copied from the checklist item setup table. -
RequiredFlag: boolean
Title:
Required
Maximum Length:1
Indicates whether this inspection checklist item is required. It is copied from the checklist item setup table. The value is Y or N. -
SubcategoryCode: string
Title:
Subcategory
Maximum Length:30
The subcategory of the inspection checklist item. This is copied from the checklist item setup table.
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.