Update a task and checklist setting
patch
/fscmRestApi/resources/11.13.18.05/hedTaskSettings/{SettingId}
Request
Path Parameters
-
SettingId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
Header Parameters
-
Metadata-Context: string
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: string
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
-
SettingDescription: string
Title:
Task and Checklist Setting Description
Maximum Length:1000
Description of the task and checklist setting. -
SettingName: string
Title:
Task and Checklist Setting Name
Maximum Length:100
Name of the task and checklist setting. -
SettingValue: string
Title:
Task and Checklist Setting Value
Maximum Length:100
Value stored against the task and checklist setting.
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 : hedTaskSettings-item-response
Type:
Show Source
object
-
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
Date when the record was last updated. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SettingCode: string
Title:
Task and Checklist Setting Code
Maximum Length:100
Default Value:HEY_TASK_AUTO_COMPLETE
Alternate unique identifier for the task and checklist setting. -
SettingDescription: string
Title:
Task and Checklist Setting Description
Maximum Length:1000
Description of the task and checklist setting. -
SettingId: integer
(int64)
Title:
Task and Checklist Setting Identifier
Read Only:true
Unique identifier for the task and checklist setting. -
SettingName: string
Title:
Task and Checklist Setting Name
Maximum Length:100
Name of the task and checklist setting. -
SettingValue: string
Title:
Task and Checklist Setting Value
Maximum Length:100
Value stored against the task and checklist setting.
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.