Jump to

• Request
• Response

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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "SettingDescription":{
            "title":"Task and Checklist Setting Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the task and checklist setting.",
            "nullable":true
        },
        "SettingName":{
            "title":"Task and Checklist Setting Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the task and checklist setting.",
            "nullable":false
        },
        "SettingValue":{
            "title":"Task and Checklist Setting Value",
            "maxLength":100,
            "type":"string",
            "description":"Value stored against the task and checklist setting.",
            "nullable":true
        }
    }
}

Back to Top

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.

Body ()

Root Schema : hedTaskSettings-item-response

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"Date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SettingCode":{
            "title":"Task and Checklist Setting Code",
            "maxLength":100,
            "type":"string",
            "description":"Alternate unique identifier for the task and checklist setting.",
            "nullable":false,
            "default":"HEY_TASK_AUTO_COMPLETE",
            "x-hints":{
                "dependencies":[
                    "CategoryCode"
                ]
            },
            "x-queryable":true
        },
        "SettingDescription":{
            "title":"Task and Checklist Setting Description",
            "maxLength":1000,
            "type":"string",
            "description":"Description of the task and checklist setting.",
            "nullable":true,
            "x-queryable":true
        },
        "SettingId":{
            "title":"Task and Checklist Setting Identifier",
            "type":"integer",
            "description":"Unique identifier for the task and checklist setting.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "SettingName":{
            "title":"Task and Checklist Setting Name",
            "maxLength":100,
            "type":"string",
            "description":"Name of the task and checklist setting.",
            "nullable":false,
            "x-queryable":true
        },
        "SettingValue":{
            "title":"Task and Checklist Setting Value",
            "maxLength":100,
            "type":"string",
            "description":"Value stored against the task and checklist setting.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top