Update a checklist item's instructions
patch
/fscmRestApi/resources/11.13.18.05/publicSectorInstructions/{publicSectorInstructionsUniqID}
Request
Path Parameters
-
publicSectorInstructionsUniqID(required): string
This is the hash key of the attributes which make up the composite key--- AgencyId, ChecklistId, ChecklistItemId and InstructionCode ---for the Instructions resource and used to uniquely identify an instance of Instructions. The client should not generate the hash key value. Instead, the client should query on the Instructions collection resource with a filter on the primary key values in order to navigate to a specific instance of Instructions.
For example: publicSectorInstructions?q=AgencyId=<value1>;ChecklistId=<value2>;ChecklistItemId=<value3>;InstructionCode=<value4>
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
-
InstructionText: string
Title:
Instructional Text
Maximum Length:1000
The text that includes the instructions for an inspection checklist item.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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 : publicSectorInstructions-item-response
Type:
Show Source
object
-
AgencyId: integer
(int32)
Title:
Agency ID
Default Value:1
The identifier for the public sector agency associated with these checklist item instructions. -
ChecklistId: string
Title:
Checklist
Maximum Length:15
The unique identifier for an inspection checklist. -
ChecklistItemId: string
Title:
Checklist Item
Maximum Length:15
The unique identifier for an inspection checklist item. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the instructions. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the instructions were created. -
InstructionCode: string
Title:
Instructions
Maximum Length:15
The code for the instructions that are associated with an item in an inspection checklist. -
InstructionText: string
Title:
Instructional Text
Maximum Length:1000
The text that includes the instructions for an inspection checklist item. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the instructions were last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The session login associated with the user who last updated the instructions. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.