Jump to

• Request
• Response

Update a notification's metric

patch

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/assetDetails/{AssetId}/child/notificationMetrics/{NotificationId}

Request

Path Parameters

• AssetId(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=
• CampaignId(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=
• NotificationId(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

{
    "type":"object",
    "properties":{
    }
}

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 : communicateUICampaignDetails-assetDetails-notificationMetrics-item-response

Type: object

Show Source

• AssetFrequency: integer (int32)
  Read Only: true

  Attribute for the frequency with which the grow notification email is sent out.
• AssetId: integer (int64)
  Read Only: true

  Internal identifier for a grow notification's metrics.
• Clicks: number
  Read Only: true

  Count of unique clicks registered on the grow notification email so far.
• LastDeliveryDate: string (date-time)
  Read Only: true

  Date after which the application won't send the grow notification email.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NextCycleDate: string (date-time)
  Read Only: true

  Date on which the application will send the next grow notification email.
• NotificationId: integer (int64)
  Read Only: true

  Unique identifier of a grow notification.
• NotificationsSent: number
  Read Only: true

  Count of all the grow notification emails sent so far.
• Opened: number
  Read Only: true

  Count of all the unique opens on a grow notification email so far.
• StartDeliveryDate: string (date-time)
  Read Only: true

  Date on which the application sent the first grow notification email.
• TotalCycles: integer
  Read Only: true

  Total number of all the grow notification email cycles.

{
    "type":"object",
    "properties":{
        "Opened":{
            "type":"number",
            "description":"Count of all the unique opens on a grow notification email so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastDeliveryDate":{
            "type":"string",
            "description":"Date after which the application won't send the grow notification email.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NotificationId":{
            "type":"integer",
            "description":"Unique identifier of a grow notification.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TotalCycles":{
            "type":"integer",
            "description":"Total number of all the grow notification email cycles.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NextCycleDate":{
            "type":"string",
            "description":"Date on which the application will send the next grow notification email.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Clicks":{
            "type":"number",
            "description":"Count of unique clicks registered on the grow notification email so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetFrequency":{
            "type":"integer",
            "description":"Attribute for the frequency with which the grow notification email is sent out.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":2
            },
            "x-queryable":true
        },
        "NotificationsSent":{
            "type":"number",
            "description":"Count of all the grow notification emails sent so far.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssetId":{
            "type":"integer",
            "description":"Internal identifier for a grow notification's metrics.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StartDeliveryDate":{
            "type":"string",
            "description":"Date on which the application sent the first grow notification email.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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