Update a checklist
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
publicSectorInspectionChecklistsUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId and ChecklistId ---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: publicSectorInspectionChecklists?q=AgencyId=<value1>;ChecklistId=<value2>
The following table describes the body parameters in the request for this task.
Root Schema : publicSectorInspectionChecklists-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with this inspection checklist. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type used for the inspection checklist. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItem(optional):
array Inspection Checklist Items
Title:
Inspection Checklist ItemsThe inspection checklists resource is used to view, create, delete, or modify an inspection checklist. An inspection checklist identifies the scope of inspections that an inspector must perform during an inspection. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. -
CommonComment(optional):
string
Title:
CommentMaximum Length:1000The comments for a specific inspection checklist. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the checklist. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the checklist was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of an inspection checklist. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates whether the inspection checklist is available to be used. The default value is true. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the checklist was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the checklist. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates whether a failing result for the checklist consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
MaximumScore(optional):
integer(int32)
Title:
Maximum ScoreThe maximum score possible for an inspection checklist. -
MinimumPassingScore(optional):
integer(int32)
Title:
Minimum Passing ScoreThe minimum checklist score that is considered a passing result. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates whether this inspection checklist is required. The default value is true. -
Score(optional):
integer(int32)
Title:
ScoreThe calculated score of the checklist. -
ScoringMethod(optional):
string
Title:
Scoring MethodMaximum Length:15The method used for scoring a checklist. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.
Nested Schema : Inspection Checklist Items
Type:
arrayTitle:
Inspection Checklist ItemsThe inspection checklists resource is used to view, create, delete, or modify an inspection checklist. An inspection checklist identifies the scope of inspections that an inspector must perform during an inspection. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with this inspection checklist item. -
CategoryCode(optional):
string
Title:
CategoryMaximum Length:30The category of the inspection checklist item. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist ItemMaximum Length:15The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the checklist item. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the checklist item was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:300The description of the inspection checklist item. -
Instruction(optional):
array Inspection Checklist Instructions
Title:
Inspection Checklist InstructionsThe inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the checklist item was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the checklist item. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates whether this inspection checklist item is required. The default value is true. -
Score(optional):
integer(int32)
Title:
ScoreThe score that the checklist item received. -
SubcategoryCode(optional):
string
Title:
SubcategoryMaximum Length:30The subcategory of the inspection checklist item.
Nested Schema : Inspection Checklist Instructions
Type:
arrayTitle:
Inspection Checklist InstructionsThe inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-Instruction-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist ItemMaximum Length:15The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the instructions. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the instructions were created. -
InstructionCode(optional):
string
Title:
InstructionsMaximum Length:15The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText(optional):
string
Title:
Instructional TextMaximum Length:1000The text that includes the instructions for an inspection checklist item. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the instructions were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the instructions. -
links(optional):
array Items
Title:
ItemsLink Relations
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 : publicSectorInspectionChecklists-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with this inspection checklist. -
AssessmentType(optional):
string
Title:
Assessment TypeMaximum Length:15The name of the assessment type used for the inspection checklist. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItem(optional):
array Inspection Checklist Items
Title:
Inspection Checklist ItemsThe inspection checklists resource is used to view, create, delete, or modify an inspection checklist. An inspection checklist identifies the scope of inspections that an inspector must perform during an inspection. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. -
CommonComment(optional):
string
Title:
CommentMaximum Length:1000The comments for a specific inspection checklist. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the checklist. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the checklist was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:100The description of an inspection checklist. -
EnabledFlag(optional):
boolean
Title:
EnabledIndicates whether the inspection checklist is available to be used. The default value is true. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the checklist was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the checklist. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates whether a failing result for the checklist consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
MaximumScore(optional):
integer(int32)
Title:
Maximum ScoreThe maximum score possible for an inspection checklist. -
MinimumPassingScore(optional):
integer(int32)
Title:
Minimum Passing ScoreThe minimum checklist score that is considered a passing result. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates whether this inspection checklist is required. The default value is true. -
Score(optional):
integer(int32)
Title:
ScoreThe calculated score of the checklist. -
ScoringMethod(optional):
string
Title:
Scoring MethodMaximum Length:15The method used for scoring a checklist. For example, Bottom Up is a scoring method that adds scores for each checklist starting with zero.
Nested Schema : Inspection Checklist Items
Type:
arrayTitle:
Inspection Checklist ItemsThe inspection checklists resource is used to view, create, delete, or modify an inspection checklist. An inspection checklist identifies the scope of inspections that an inspector must perform during an inspection. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with this inspection checklist item. -
CategoryCode(optional):
string
Title:
CategoryMaximum Length:30The category of the inspection checklist item. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist ItemMaximum Length:15The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the checklist item. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the checklist item was created. -
Description(optional):
string
Title:
DescriptionMaximum Length:300The description of the inspection checklist item. -
Instruction(optional):
array Inspection Checklist Instructions
Title:
Inspection Checklist InstructionsThe inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the checklist item was last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the checklist item. -
links(optional):
array Items
Title:
ItemsLink Relations -
MajorViolationFlag(optional):
boolean
Title:
Major ViolationIndicates whether a failing result for the checklist item consititutes a major violation. If the value is true, a failing result constitutes a major violation. The default value is false. -
RequiredFlag(optional):
boolean
Title:
RequiredIndicates whether this inspection checklist item is required. The default value is true. -
Score(optional):
integer(int32)
Title:
ScoreThe score that the checklist item received. -
SubcategoryCode(optional):
string
Title:
SubcategoryMaximum Length:30The subcategory of the inspection checklist item.
Nested Schema : Inspection Checklist Instructions
Type:
arrayTitle:
Inspection Checklist InstructionsThe inspection checklist items resource is used to view, create, delete, or modify an inspection checklist item. An inspection checklist item identifies part of the inspection checklist. For example, a Residential Addition inspection may contain inspection checklists for Kitchen, Solar, and so on. The Kitchen checklist may contain checklist items for Plumbing and Electrical.
Show Source
Nested Schema : publicSectorInspectionChecklists-ChecklistItem-Instruction-item
Type:
Show Source
object-
AgencyId(optional):
integer(int64)
Title:
Agency IDThe identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId(optional):
string
Title:
ChecklistMaximum Length:15The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist ItemMaximum Length:15The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created ByMaximum Length:64The user who created the instructions. -
CreationDate(optional):
string(date-time)
Title:
Creation DateThe date when the instructions were created. -
InstructionCode(optional):
string
Title:
InstructionsMaximum Length:15The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText(optional):
string
Title:
Instructional TextMaximum Length:1000The text that includes the instructions for an inspection checklist item. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated DateThe date when the instructions were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated ByMaximum Length:64The session login associated with the user who last updated the instructions. -
links(optional):
array Items
Title:
ItemsLink Relations
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.