Jump to

• Request
• Response

Update a campaign audience

patch

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}

Request

Path Parameters

• AudienceId(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=

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

• AudienceId: integer (int64)
  Internal identifier for the association between a campaign and its corresponding audience.
• AudienceSourceId(required): integer (int64)
  Title: Audience

  Internal identifier for the selected audience list.
• AudienceSourceType(required): string
  Title: Audience Type

  Maximum Length: 64

  Type of audience list.
• CampaignAudienceSourceItems: array Campaign Target Audience Details
  Title: Campaign Target Audience Details

  The CampaignAudienceSourceItems resource provides the target audience for a campaign.
• CampaignId(required): integer (int64)
  Internal identifier for the campaign.
• metrics: array Campaign Audience Details Metrics
  Title: Campaign Audience Details Metrics

  The metrics resource retrieves the metrics associated with the audience for a campaign.
• ObjectVersionNumber: integer (int32)
  Version number associated with the audience that the user retrieved.

{
    "required":[
        "AudienceSourceId",
        "AudienceSourceType",
        "CampaignId"
    ],
    "type":"object",
    "properties":{
        "CampaignId":{
            "type":"integer",
            "description":"Internal identifier for the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the audience that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "AudienceId":{
            "type":"integer",
            "description":"Internal identifier for the association between a campaign and its corresponding audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AudienceSourceType":{
            "title":"Audience Type",
            "maxLength":64,
            "type":"string",
            "description":"Type of audience list.",
            "nullable":false
        },
        "metrics":{
            "title":"Campaign Audience Details Metrics",
            "type":"array",
            "description":"The metrics resource retrieves the metrics associated with the audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-metrics-item-patch-request"
            }
        },
        "CampaignAudienceSourceItems":{
            "title":"Campaign Target Audience Details",
            "type":"array",
            "description":"The CampaignAudienceSourceItems resource provides the target audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-patch-request"
            }
        },
        "AudienceSourceId":{
            "title":"Audience",
            "type":"integer",
            "description":"Internal identifier for the selected audience list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : Campaign Target Audience Details

Type: array

Title: Campaign Target Audience Details

The CampaignAudienceSourceItems resource provides the target audience for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-patch-request

{
    "title":"Campaign Target Audience Details",
    "type":"array",
    "description":"The CampaignAudienceSourceItems resource provides the target audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-patch-request"
    }
}

Nested Schema : Campaign Audience Details Metrics

Type: array

Title: Campaign Audience Details Metrics

The metrics resource retrieves the metrics associated with the audience for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-audienceDetails-metrics-item-patch-request

{
    "title":"Campaign Audience Details Metrics",
    "type":"array",
    "description":"The metrics resource retrieves the metrics associated with the audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-metrics-item-patch-request"
    }
}

Nested Schema : communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-patch-request

Type: object

Show Source

• AudienceId: integer (int64)
  Internal identifier for the source of the campaign audience.
• AudienceItemId: integer (int64)
  Unique identifier generated by the application for the campaign target audience.
• ItemId: integer (int64)
  Unique identifier generated by user input for the campaign target audience.

{
    "type":"object",
    "properties":{
        "AudienceItemId":{
            "type":"integer",
            "description":"Unique identifier generated by the application for the campaign target audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "AudienceId":{
            "type":"integer",
            "description":"Internal identifier for the source of the campaign audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier generated by user input for the campaign target audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : communicateUICampaignDetails-audienceDetails-metrics-item-patch-request

Type: object

Show Source

• AudienceCount: integer
  Audience count associated with the campaign.
• AudienceId: integer (int64)
  Audience identifier.
• EntityId: integer (int64)
  Entity identifier for the audience criteria.
• EntityName: string
  Maximum Length: 2000

  Name of the selected entity.
• MetricId: integer (int64)
  Internal identifier for a metric.
• MetricType: string
  Maximum Length: 30

  Types of metrics.
• ObjectVersionNumber: integer (int32)
  Version number associated with the audience metrics that the user retrieved.

{
    "type":"object",
    "properties":{
        "EntityId":{
            "type":"integer",
            "description":"Entity identifier for the audience criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MetricId":{
            "type":"integer",
            "description":"Internal identifier for a metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EntityName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the selected entity.",
            "nullable":false
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the audience metrics that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "MetricType":{
            "maxLength":30,
            "type":"string",
            "description":"Types of metrics.",
            "nullable":false
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Audience count associated with the campaign.",
            "nullable":false
        },
        "AudienceId":{
            "type":"integer",
            "description":"Audience identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

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-audienceDetails-item-response

Type: object

Show Source

• AudienceCount: integer
  Read Only: true

  Total number of employees who will see the post.
• AudienceExtractionDate: string (date-time)
  Read Only: true

  Date when the audience was extracted.
• AudienceId: integer (int64)
  Internal identifier for the association between a campaign and its corresponding audience.
• AudienceSourceId: integer (int64)
  Title: Audience

  Internal identifier for the selected audience list.
• AudienceSourceName: string
  Read Only: true

  Maximum Length: 255

  Name of the selected audience list.
• AudienceSourceType: string
  Title: Audience Type

  Maximum Length: 64

  Type of audience list.
• CampaignAudienceSourceItems: array Campaign Target Audience Details
  Title: Campaign Target Audience Details

  The CampaignAudienceSourceItems resource provides the target audience for a campaign.
• CampaignId: integer (int64)
  Internal identifier for the campaign.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the audience.
• CreationDate: string (date-time)
  Read Only: true

  Date the audience was added to the campaign.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the audience was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the audience.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the audience.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• metrics: array Campaign Audience Details Metrics
  Title: Campaign Audience Details Metrics

  The metrics resource retrieves the metrics associated with the audience for a campaign.
• ObjectVersionNumber: integer (int32)
  Version number associated with the audience that the user retrieved.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the audience.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the audience was added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the audience.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceExtractionDate":{
            "type":"string",
            "description":"Date when the audience was extracted.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceSourceType":{
            "title":"Audience Type",
            "maxLength":64,
            "type":"string",
            "description":"Type of audience list.",
            "nullable":false,
            "x-queryable":true
        },
        "CampaignId":{
            "type":"integer",
            "description":"Internal identifier for the campaign.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the audience that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Total number of employees who will see the post.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AudienceId":{
            "type":"integer",
            "description":"Internal identifier for the association between a campaign and its corresponding audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AudienceSourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the selected audience list.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "metrics":{
            "title":"Campaign Audience Details Metrics",
            "type":"array",
            "description":"The metrics resource retrieves the metrics associated with the audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-metrics-item-response"
            }
        },
        "CampaignAudienceSourceItems":{
            "title":"Campaign Target Audience Details",
            "type":"array",
            "description":"The CampaignAudienceSourceItems resource provides the target audience for a campaign.",
            "items":{
                "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response"
            }
        },
        "AudienceSourceId":{
            "title":"Audience",
            "type":"integer",
            "description":"Internal identifier for the selected audience list.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the audience was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated to the user who last updated the audience.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Campaign Target Audience Details

Type: array

Title: Campaign Target Audience Details

The CampaignAudienceSourceItems resource provides the target audience for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response

{
    "title":"Campaign Target Audience Details",
    "type":"array",
    "description":"The CampaignAudienceSourceItems resource provides the target audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response"
    }
}

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 : Campaign Audience Details Metrics

Type: array

Title: Campaign Audience Details Metrics

The metrics resource retrieves the metrics associated with the audience for a campaign.

Show Source

• Array of: object communicateUICampaignDetails-audienceDetails-metrics-item-response

{
    "title":"Campaign Audience Details Metrics",
    "type":"array",
    "description":"The metrics resource retrieves the metrics associated with the audience for a campaign.",
    "items":{
        "$ref":"#/components/schemas/communicateUICampaignDetails-audienceDetails-metrics-item-response"
    }
}

Nested Schema : communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response

Type: object

Show Source

• AudienceId: integer (int64)
  Internal identifier for the source of the campaign audience.
• AudienceItemId: integer (int64)
  Unique identifier generated by the application for the campaign target audience.
• ItemId: integer (int64)
  Unique identifier generated by user input for the campaign target audience.
• ItemMeaning: string
  Read Only: true

  Maximum Length: 255

  Name of the campaign target audience.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "AudienceItemId":{
            "type":"integer",
            "description":"Unique identifier generated by the application for the campaign target audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AudienceId":{
            "type":"integer",
            "description":"Internal identifier for the source of the campaign audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ItemMeaning":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the campaign target audience.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Unique identifier generated by user input for the campaign target audience.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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."
        }
    }
}

Nested Schema : communicateUICampaignDetails-audienceDetails-metrics-item-response

Type: object

Show Source

• AudienceCount: integer
  Audience count associated with the campaign.
• AudienceId: integer (int64)
  Audience identifier.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who added the metrics.
• CreationDate: string (date-time)
  Read Only: true

  Date when the metrics were added to the campaign.
• EntityId: integer (int64)
  Entity identifier for the audience criteria.
• EntityName: string
  Maximum Length: 2000

  Name of the selected entity.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date when the audience metrics were last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Person who last updated the audience metrics.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated to the user who last updated the audience metrics.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MetricId: integer (int64)
  Internal identifier for a metric.
• MetricType: string
  Maximum Length: 30

  Types of metrics.
• ObjectVersionNumber: integer (int32)
  Version number associated with the audience metrics that the user retrieved.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who last updated the audience metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date when the metrics were added to the campaign.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Person who added the metrics.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EntityName":{
            "maxLength":2000,
            "type":"string",
            "description":"Name of the selected entity.",
            "nullable":false,
            "x-queryable":true
        },
        "MetricType":{
            "maxLength":30,
            "type":"string",
            "description":"Types of metrics.",
            "nullable":false,
            "x-queryable":true
        },
        "EntityId":{
            "type":"integer",
            "description":"Entity identifier for the audience criteria.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "MetricId":{
            "type":"integer",
            "description":"Internal identifier for a metric.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Version number associated with the audience metrics that the user retrieved.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "AudienceCount":{
            "type":"integer",
            "description":"Audience count associated with the campaign.",
            "nullable":false,
            "x-queryable":true
        },
        "AudienceId":{
            "type":"integer",
            "description":"Audience identifier.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date when the audience metrics were last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated to the user who last updated the audience metrics.",
            "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"
    }
}

Links

CampaignAudienceSourceItems

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/CampaignAudienceSourceItems

Parameters:

• AudienceId: $request.path.AudienceId
• CampaignId: $request.path.CampaignId

The CampaignAudienceSourceItems resource provides the target audience for a campaign.

metrics

Operation: /hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/audienceDetails/{AudienceId}/child/metrics

Parameters:

• AudienceId: $request.path.AudienceId
• CampaignId: $request.path.CampaignId

The metrics resource retrieves the metrics associated with the audience for a campaign.

Back to Top