Create a business object association
post
/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails/{CampaignId}/child/boAssociation
Request
Path Parameters
-
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:
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.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
BoAssignedAfterDate: string
(date-time)
Title:
Journey Assigned After
Business object assignment date. -
boAssocItems: array
Campaign Business Object Association Items
Title:
Campaign Business Object Association Items
The boAssocItems resource retrieves the items associated with the business object association for a campaign. -
BoGoal(required): string
Maximum Length:
30
Name of the business object goal -
BoType(required): string
Maximum Length:
30
Type of business object association. -
CampaignId(required): integer
(int64)
Internal identifier for the campaign associated with the business object association.
-
CampBoId: integer
(int64)
Internal identifier for the business object association.
-
ExcludeBoAudFlag: boolean
Maximum Length:
1
Exclude business object association audience indicator for the campaign. -
ObjectVersionNumber: integer
(int32)
Version number associated with the business object association that the user retrieved.
Nested Schema : Campaign Business Object Association Items
Type:
array
Title:
Campaign Business Object Association Items
The boAssocItems resource retrieves the items associated with the business object association for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-item-post-request
Type:
Show Source
object
-
BoId(required): integer
(int64)
Internal identifier for the business object.
-
campaignBoMetrics: array
Campaign Business Object Association Metrics
Title:
Campaign Business Object Association Metrics
The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign. -
CampBoId(required): integer
(int64)
Internal identifier for the business object association.
-
CampBoItemId: integer
(int64)
Internal identifier for the business object association items.
-
ObjectVersionNumber: integer
(int32)
Version number associated with the business object association items that the user retrieved.
Nested Schema : Campaign Business Object Association Metrics
Type:
array
Title:
Campaign Business Object Association Metrics
The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-item-post-request
Type:
Show Source
object
-
CampBoItemId: integer
(int64)
Internal identifier for the campaign business object metrics associated with the business object association items.
-
Count: integer
(int32)
Total audience count associated with the campaign business object metrics.
-
DisplayContext: string
Maximum Length:
30
Context for the business object association. -
MetricId: integer
(int64)
Internal identifier for the campaign business object metrics.
-
ObjectVersionNumber: integer
(int32)
Version number associated with the business object metrics that the user retrieved.
-
Status: string
Maximum Length:
30
Status of the business object association.
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 : communicateUICampaignDetails-boAssociation-item-response
Type:
Show Source
object
-
BoAssignedAfterDate: string
(date-time)
Title:
Journey Assigned After
Business object assignment date. -
boAssocItems: array
Campaign Business Object Association Items
Title:
Campaign Business Object Association Items
The boAssocItems resource retrieves the items associated with the business object association for a campaign. -
BoGoal: string
Maximum Length:
30
Name of the business object goal -
BoType: string
Maximum Length:
30
Type of business object association. -
CampaignId: integer
(int64)
Internal identifier for the campaign associated with the business object association.
-
CampBoId: integer
(int64)
Internal identifier for the business object association.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who added the business object association. -
CreationDate: string
(date-time)
Read Only:
true
Date when the business object association was added to the campaign. -
ExcludeBoAudFlag: boolean
Maximum Length:
1
Exclude business object association audience indicator for the campaign. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the business object association was last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the business object association. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the business object association. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Version number associated with the business object association that the user retrieved.
Nested Schema : Campaign Business Object Association Items
Type:
array
Title:
Campaign Business Object Association Items
The boAssocItems resource retrieves the items associated with the business object association for a campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-item-response
Type:
Show Source
object
-
BoId: integer
(int64)
Internal identifier for the business object.
-
campaignBoMetrics: array
Campaign Business Object Association Metrics
Title:
Campaign Business Object Association Metrics
The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign. -
CampBoId: integer
(int64)
Internal identifier for the business object association.
-
CampBoItemId: integer
(int64)
Internal identifier for the business object association items.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who added the business object association items. -
CreationDate: string
(date-time)
Read Only:
true
Date when the business object association items were added to the campaign. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date when the business object association items were last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the business object association items. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the business object association items. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Version number associated with the business object association items that the user retrieved.
Nested Schema : Campaign Business Object Association Metrics
Type:
array
Title:
Campaign Business Object Association Metrics
The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-item-response
Type:
Show Source
object
-
CampBoItemId: integer
(int64)
Internal identifier for the campaign business object metrics associated with the business object association items.
-
Count: integer
(int32)
Total audience count associated with the campaign business object metrics.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
Person who added the business object metrics. -
CreationDate: string
(date-time)
Read Only:
true
Date when the business object metrics items were added to the campaign. -
DisplayContext: string
Maximum Length:
30
Context for the business object association. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date the business object metrics were last updated. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
Person who last updated the business object metrics. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated to the user who last updated the business object metrics. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MetricId: integer
(int64)
Internal identifier for the campaign business object metrics.
-
ObjectVersionNumber: integer
(int32)
Version number associated with the business object metrics that the user retrieved.
-
Status: string
Maximum Length:
30
Status of the business object association.
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.
Links
- boAssocItems
-
Parameters:
- CampBoId:
$request.path.CampBoId
- CampaignId:
$request.path.CampaignId
The boAssocItems resource retrieves the items associated with the business object association for a campaign. - CampBoId: