Get all campaign assets
patch
/hcmRestApi/resources/11.13.18.05/recruitingCampaignDetails/{CampaignCode}/child/campaignAssets/{AssetId}
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=
-
CampaignCode(required): string
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
Root Schema : schema
Type:
Show Source
object
-
AssetName: string
Maximum Length:
240
Name assigned to each asset. -
AssetStatusCode: string
Maximum Length:
30
Code assigned to each status of asset. -
AssetTypeCode: string
Maximum Length:
30
Code assigned to each type of asset. -
AudienceDerivedFlag: boolean
Maximum Length:
1
Indicates that the campaign is for derived audience. -
CampaignAssetChannels: array
Campaign Asset Channels
Title:
Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign. -
campaignAssetSegments: array
Campaign Asset Segments
Title:
Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign. -
DisplayRank: integer
Rank of the campaign asset.
-
MessageDesignId: integer
(int64)
ID assigned to each message design.
-
ParentAssetId: integer
(int64)
ID assigned to the parent asset.
-
ScheduledDate: string
(date-time)
Date when the campaign is scheduled.
-
SortOrderDate: string
(date-time)
Date of sorting the order.
Nested Schema : Campaign Asset Channels
Type:
array
Title:
Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
Show Source
Nested Schema : Campaign Asset Segments
Type:
array
Title:
Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
Show Source
Nested Schema : recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-patch-request
Type:
Show Source
object
Nested Schema : recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-patch-request
Type:
Show Source
object
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 : recruitingCampaignDetails-campaignAssets-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Read Only:
true
ID assigned to each asset for campaign asset. -
AssetName: string
Maximum Length:
240
Name assigned to each asset. -
AssetStatusCode: string
Maximum Length:
30
Code assigned to each status of asset. -
AssetTypeCode: string
Maximum Length:
30
Code assigned to each type of asset. -
AudienceDerivedFlag: boolean
Maximum Length:
1
Indicates that the campaign is for derived audience. -
CampaignAssetChannels: array
Campaign Asset Channels
Title:
Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign. -
campaignAssetSegments: array
Campaign Asset Segments
Title:
Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign. -
DisplayRank: integer
Rank of the campaign asset.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
MessageDesignId: integer
(int64)
ID assigned to each message design.
-
ParentAssetId: integer
(int64)
ID assigned to the parent asset.
-
ScheduledDate: string
(date-time)
Date when the campaign is scheduled.
-
SortOrderDate: string
(date-time)
Date of sorting the order.
Nested Schema : Campaign Asset Channels
Type:
array
Title:
Campaign Asset Channels
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign.
Show Source
Nested Schema : Campaign Asset Segments
Type:
array
Title:
Campaign Asset Segments
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : recruitingCampaignDetails-campaignAssets-CampaignAssetChannels-item-response
Type:
Show Source
object
-
AssetId: integer
(int64)
Read Only:
true
ID assigned to each asset for campaign asset channel. -
ChannelId: integer
Read Only:
true
ID assigned to each channel. -
ChannelPostURL: string
Read Only:
true
Maximum Length:1000
URL of the channel where campaign is posted. -
ChannelTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each type of channel. -
ChannelTypeMeaning: string
Read Only:
true
Maximum Length:80
Description of each channel type. -
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : recruitingCampaignDetails-campaignAssets-campaignAssetSegments-item-response
Type:
Show Source
object
-
AssetSegmentId: integer
(int64)
Read Only:
true
ID assigned to each asset segment. -
CriteriaTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each criteria type. -
GoalResponseId: integer
(int64)
Read Only:
true
ID assigned to each response of a goal for the campaign asset segment. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ResponseLabel: string
Read Only:
true
Maximum Length:240
Label assigned to each response for the campaign asset segment. -
SegmentName: string
Read Only:
true
Name of each segment. -
SegmentTypeCode: string
Read Only:
true
Maximum Length:30
Code assigned to each segment type. -
SegmentTypeMeaning: string
Title:
Meaning
Read Only:true
Maximum Length:80
Description of each segment type.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- CampaignAssetChannels
-
Parameters:
- AssetId:
$request.path.AssetId
- CampaignCode:
$request.path.CampaignCode
The CampaignAssetChannels resource is a child of campaignAssets. It includes all the asset channels of the campaign. - AssetId:
- campaignAssetSegments
-
Parameters:
- AssetId:
$request.path.AssetId
- CampaignCode:
$request.path.CampaignCode
The campaignAssetSegments resource is a child of campaignAssets. It includes all the asset segments of the campaign. - AssetId: