Update a checklist item's instructions
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInspectionChecklists/{publicSectorInspectionChecklistsUniqID}/child/ChecklistItem/{ChecklistItemUniqID}/child/Instruction/{InstructionUniqID}
Request
Supported Media Types
- application/vnd.oracle.adf.resourceitem+json
- application/json
Path Parameters
-
ChecklistItemUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ChecklistId and ChecklistItemId ---for the Inspection Checklist Items resource and used to uniquely identify an instance of Inspection Checklist Items. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklist Items collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklist Items.
For example: ChecklistItem?q=AgencyId=<value1>;ChecklistId=<value2>;ChecklistItemId=<value3> -
InstructionUniqID: integer
This is the hash key of the attributes which make up the composite key--- AgencyId, ChecklistId, ChecklistItemId and InstructionCode ---for the Inspection Checklist Instructions resource and used to uniquely identify an instance of Inspection Checklist Instructions. The client should not generate the hash key value. Instead, the client should query on the Inspection Checklist Instructions collection resource with a filter on the primary key values in order to navigate to a specific instance of Inspection Checklist Instructions.
For example: Instruction?q=AgencyId=<value1>;ChecklistId=<value2>;ChecklistItemId=<value3>;InstructionCode=<value4> -
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-ChecklistItem-Instruction-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist Item
Maximum Length:15
The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the instructions. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the instructions were created. -
InstructionCode(optional):
string
Title:
Instructions
Maximum Length:15
The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText(optional):
string
Title:
Instructional Text
Maximum Length:1000
The text that includes the instructions for an inspection checklist item. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the instructions were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The session login associated with the user who last updated the instructions. -
links(optional):
array Items
Title:
Items
Link Relations
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 : publicSectorInspectionChecklists-ChecklistItem-Instruction-item
Type:
Show Source
object
-
AgencyId(optional):
integer(int64)
Title:
Agency ID
The identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId(optional):
string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItemId(optional):
string
Title:
Checklist Item
Maximum Length:15
The unique identifier for an inspection checklist item. -
CreatedBy(optional):
string
Title:
Created By
Maximum Length:64
The user who created the instructions. -
CreationDate(optional):
string(date-time)
Title:
Creation Date
The date when the instructions were created. -
InstructionCode(optional):
string
Title:
Instructions
Maximum Length:15
The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText(optional):
string
Title:
Instructional Text
Maximum Length:1000
The text that includes the instructions for an inspection checklist item. -
LastUpdateDate(optional):
string(date-time)
Title:
Last Updated Date
The date when the instructions were last updated. -
LastUpdatedBy(optional):
string
Title:
Last Updated By
Maximum Length:64
The session login associated with the user who last updated the instructions. -
links(optional):
array Items
Title:
Items
Link Relations
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.