Skip to main content

CampaignCreate

Properties​

NameTypeDescriptionNotes
NameStringName of the campaign.[required]
DescriptionStringDescription of the campaign.[required]
DeadlineSystem.DateTimeThe campaign's completion deadline date. While creating campaign, If deadline is passed as empty then automatically it will be set for two weeks later from current time.[optional]
DeadlineTimezoneStringThe timezone must be in a valid ISO 8601 format. Timezones in ISO 8601 are represented as UTC (represented as 'Z') or as an offset from UTC. The offset format can be +/-hh:mm, +/-hhmm, or +/-hh.[optional]
EmailNotificationEnabledBooleanEnables email notification for this campaign[required][default to $false]
AutoRevokeAllowedBooleanAllows auto revoke for this campaign[required][default to $false]
RecommendationsEnabledBooleanEnables IAI for this campaign. Accepts true even if the IAI product feature is off. If IAI is turned off then campaigns generated from this template will indicate false. The real value will then be returned if IAI is ever enabled for the org in the future.[required][default to $false]
SunsetCommentsRequiredBooleanDetermines if comments on sunset date changes are required.[required][default to $true]
SourceIds[]StringA direct list of sourceIds to include in this campaign.[optional]
AutoActivateBooleanIf autoActivate is true, the campaign will be activated automatically after generation completes. In this case, a deadline must be provided; otherwise, campaign creation will fail.[required][default to $false]
TypeCampaignType[required]
ReviewerReviewer[required]
FilterRefCampaignFilterIdRef[optional]
InlineFilterCampaignFilterInline[optional]
SearchBasedParamsCampaignSearchBasedParams[optional]
RemediatorRefCampaignRemediatorRef[optional]
MandatoryCommentRequirementCampaignMandatoryCommentRequirement[optional]

Examples​

  • Prepare the resource
$CampaignCreate = Initialize-CampaignCreate -Name Manager Campaign `
-Description Everyone needs to be reviewed by their manager `
-Deadline Sun Mar 15 00:00:00 UTC 2020 `
-DeadlineTimezone -05:00 `
-EmailNotificationEnabled false `
-AutoRevokeAllowed false `
-RecommendationsEnabled true `
-SunsetCommentsRequired true `
-SourceIds ["0fbe863c063c4c88a35fd7f17e8a3df5"] `
-AutoActivate true `
-Type null `
-Reviewer null `
-FilterRef null `
-InlineFilter null `
-SearchBasedParams null `
-RemediatorRef null `
-MandatoryCommentRequirement null
  • Convert the resource to JSON
$CampaignCreate | ConvertTo-JSON

[Back to top]