Jump to

• Request
• Response

Update a notification override for library task

patch

/hcmRestApi/resources/11.13.18.05/journeyTaskLibrary/{LibraryJourneyTaskId}/child/notifications/{LibraryJourneyTaskNotificationId}

Request

Path Parameters

• LibraryJourneyTaskId(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=
• LibraryJourneyTaskNotificationId(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:
  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

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• NotifyOwnerFlag: boolean
  Maximum Length: 30

  Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.
• NotifyPerformerFlag: boolean
  Maximum Length: 30

  Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.

{
    "type":"object",
    "properties":{
        "NotifyPerformerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "NotifyOwnerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":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 : journeyTaskLibrary-notifications-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the notification.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the notification was created.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which notification was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated notification.
• LibraryJourneyTaskNotificationId: integer (int64)
  Unique identifier of the journey task notification.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NotifyOwnerFlag: boolean
  Maximum Length: 30

  Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.
• NotifyPerformerFlag: boolean
  Maximum Length: 30

  Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.
• OwnerExpiryTemplateId: integer (int64)
  Primary key or unique identifier of the expiry notification template for task owner.
• OwnerForceCompleteTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template for task owner.
• OwnerNotApplicableTemplateId: integer (int64)
  Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.
• OwnerTemplateId: integer (int64)
  Primary key or unique identifier of the notification template for task owner.
• PerformerExpiryTemplateId: integer (int64)
  Primary key or unique identifier of the expiry notification template for task performer.
• PerformerForceCompleteTemplateId: integer (int64)
  Primary key or unique identifier of the force completion notification template for task performer.
• PerformerNotApplicableTemplateId: integer (int64)
  Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.
• PerformerTemplateId: integer (int64)
  Primary key or unique identifier of the notification template for task performer.
• TaskEvent: string
  Maximum Length: 30

  Code of the task event. For example, task initiated, task updated, task deleted, task completed.
• TaskEventMeaning: string
  Title: Meaning

  Read Only: true

  Maximum Length: 80

  Meaning of the task event.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LibraryJourneyTaskNotificationId":{
            "type":"integer",
            "description":"Unique identifier of the journey task notification.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date on which the notification was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the notification.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "OwnerNotApplicableTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template when a task is marked as not applicable for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "NotifyPerformerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task performer needs to be notified when the event occurs. Valid values are Yes and No. Default is Yes.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "OwnerForceCompleteTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerExpiryTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the expiry notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "TaskEventMeaning":{
            "title":"Meaning",
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the task event.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "TaskEvent":{
            "maxLength":"30",
            "type":"string",
            "description":"Code of the task event. For example, task initiated, task updated, task deleted, task completed.",
            "nullable":false,
            "x-hints":{
                "controlType":"choice",
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "NotifyOwnerFlag":{
            "maxLength":"30",
            "type":"boolean",
            "description":"Indicates if the task owner needs to be notified when the event occurs. Valid values are Yes and No. Default is No.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PerformerTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "OwnerExpiryTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the expiry notification template for task owner.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "PerformerForceCompleteTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the force completion notification template for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which notification was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "PerformerNotApplicableTemplateId":{
            "type":"integer",
            "description":"Primary key or unique identifier of the notification template when a task is marked as not applicable for task performer.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":"18"
            }
        }
    }
}

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