# Retrieve a list of journey activation templates of specified step

Retrieve a list of journey activation templates of specified step.

Endpoint: POST /entities/journeys/{journeyId}/activation_templates_for_step
Version: 1.0.0
Security: TdApikeyAuth

## Path parameters:

  - `journeyId` (integer, required)
    Journey ID

## Query parameters:

  - `stepId` (string)

## Request fields (application/vnd.treasuredata.v1+json):

  - `type` (string)
    Enum: "journey"

  - `attributes` (object)

  - `attributes.name` (string, required)

  - `attributes.description` (string)

  - `attributes.state` (string)
    Enum: "draft", "simulation", "launched"

  - `attributes.goal` (object)

  - `attributes.goal.name` (string, required)

  - `attributes.goal.description` (string)

  - `attributes.goal.segmentId` (string, required)

  - `attributes.goal.target` (object)

  - `attributes.goal.target.journeyId` (string, required)
    ID of an existing journey to jump to.

  - `attributes.goal.target.journeyStageId` (string, required)
    ID of an existing stage within the target journey to jump to.

  - `attributes.journeyStages` (array)

  - `attributes.journeyStages.id` (string)
    Server-generated. Omit when creating a stage; supply to target an existing stage when updating.

  - `attributes.journeyStages.name` (string, required)

  - `attributes.journeyStages.description` (string)

  - `attributes.journeyStages.steps` (object)

  - `attributes.journeyStages.steps.uuid` (any)

  - `attributes.journeyStages.steps.uuid.type` (string, required)
    Enum: "WaitStep"

  - `attributes.journeyStages.steps.uuid.name` (string, required)

  - `attributes.journeyStages.steps.uuid.waitStepType` (string, required)
    Enum: "Duration"

  - `attributes.journeyStages.steps.uuid.waitStep` (integer, required)

  - `attributes.journeyStages.steps.uuid.waitStepUnit` (string, required)
    Enum: "day", "week"

  - `attributes.journeyStages.steps.uuid.next` (string)

  - `attributes.journeyStages.steps.uuid.waitUntilDate` (string, required)

  - `attributes.journeyStages.steps.uuid.timezone` (string, required)

  - `attributes.journeyStages.steps.uuid.waitUntilDaysOfTheWeek` (array, required)
    Array of integer representing the day of the week.
1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday
    Example: [1,5,6]

  - `attributes.journeyStages.steps.uuid.conditions` (array, required)
    the path with segment is required, but the path with moveAfter as timedOutPath = true is optional

  - `attributes.journeyStages.steps.uuid.conditions.id` (string, required)

  - `attributes.journeyStages.steps.uuid.conditions.name` (string)

  - `attributes.journeyStages.steps.uuid.conditions.segmentId` (string)
    required if timedOutPath = false

  - `attributes.journeyStages.steps.uuid.conditions.timedOutPath` (boolean)

  - `attributes.journeyStages.steps.uuid.conditions.moveAfter` (integer)

  - `attributes.journeyStages.steps.uuid.conditions.unit` (string)
    Enum: "day", "week"

  - `attributes.journeyStages.steps.uuid.conditions.next` (string)

  - `attributes.journeyStages.steps.uuid.description` (string)

  - `attributes.journeyStages.steps.uuid.journeyActivationStepId` (string, required)

  - `attributes.journeyStages.steps.uuid.branches` (array, required)

  - `attributes.journeyStages.steps.uuid.branches.name` (string, required)

  - `attributes.journeyStages.steps.uuid.branches.segmentId` (string, required)

  - `attributes.journeyStages.steps.uuid.branches.excludedPath` (boolean)

  - `attributes.journeyStages.steps.uuid.branches.next` (string)

  - `attributes.journeyStages.steps.uuid.customizedSplit` (boolean, required)

  - `attributes.journeyStages.steps.uuid.uniqueId` (string)

  - `attributes.journeyStages.steps.uuid.randomizationMode` (string)
    Controls how variant assignments behave on re-entry. "sticky" (default): deterministic assignment, same variant on every entry. "reentry": fresh random assignment on each re-entry. "periodic": assignment stable within cadence window, re-randomized at boundary.
    Enum: "sticky", "reentry", "periodic"

  - `attributes.journeyStages.steps.uuid.periodicCadence` (string)
    Required when randomizationMode is "periodic". Defines the cadence at which variant assignments reset.
    Enum: "weekly", "monthly", "yearly"

  - `attributes.journeyStages.steps.uuid.periodicBoundaryMonth` (integer)
    Required when periodicCadence is "yearly". Month of the reset boundary (1-12).

  - `attributes.journeyStages.steps.uuid.periodicBoundaryDay` (integer)
    Required when periodicCadence is "monthly" or "yearly". Day of the reset boundary (1-31). If the specified day exceeds the number of days in a given month, the last day of that month is used.

  - `attributes.journeyStages.steps.uuid.periodicBoundaryDayOfWeek` (integer)
    Required when periodicCadence is "weekly". Day of the reset boundary using ISO-8601 numbering (1=Monday, 7=Sunday).

  - `attributes.journeyStages.steps.uuid.enabledCapping` (boolean)
    Enables profile capping on the step

  - `attributes.journeyStages.steps.uuid.variants` (array, required)

  - `attributes.journeyStages.steps.uuid.variants.id` (string, required)

  - `attributes.journeyStages.steps.uuid.variants.name` (string, required)

  - `attributes.journeyStages.steps.uuid.variants.percentage` (number, required)

  - `attributes.journeyStages.steps.uuid.variants.next` (string)

  - `attributes.journeyStages.steps.uuid.variants.isControlGroup` (boolean)
    Marks a variant as the control group (required when enabledCapping is true)

  - `attributes.journeyStages.steps.uuid.variants.cappingAt` (integer)
    Capping threshold per variant (required for non-control variants when capping is enabled)

  - `attributes.journeyStages.rootStep` (string)

  - `attributes.journeyStages.exitCriterias` (array)

  - `attributes.allowReentry` (boolean)

  - `attributes.reentryMode` (string)
    Enum: "no_reentry", "reentry_unless_goal_achieved", "reentry_always"

  - `attributes.journeyBundleId` (string)
    Attach the journey to an existing journey bundle as its next version.

  - `attributes.journeyBundleName` (string)

  - `attributes.journeyBundleDescription` (string)

## Response 200 fields (application/json):

  - `data` (array, required)

  - `data.id` (string)

  - `data.type` (string)
    Enum: "activation-template"

  - `data.attributes` (object)

  - `data.attributes.audienceId` (string, required)

  - `data.attributes.name` (string, required)

  - `data.attributes.description` (string, required)

  - `data.attributes.kind` (integer)
    0: batch, 1: batch_journey

  - `data.attributes.allColumns` (boolean)
    activation all column flag  ('true' means that you use all attribute data)

  - `data.attributes.columns` (any)

  - `data.attributes.columns.id` (string)

  - `data.attributes.columns.column` (string, required)

  - `data.attributes.columns.source` (any, required)

  - `data.attributes.columns.source.column` (string, required)

  - `data.attributes.columns.source.customerGroup` (string)

  - `data.attributes.columns.source.functions` (array)

  - `data.attributes.columns.source.string` (string, required)

  - `data.attributes.columns.source.parameters` (array)
    Values for the placeholders ($1, $2, $3, ...) in the string

  - `data.attributes.columns.thisKeyNeverHit` (string)

  - `data.attributes.scheduleType` (string)
    Deprecated. Old parameter for setting schedule type. See/Use RepeatUnit instead.
    Enum: "cron", "daily", "hourly", "minutes_interval", "monthly", "none", "weekly"

  - `data.attributes.scheduleOption` (string)

  - `data.attributes.timezone` (string)

  - `data.attributes.startAt` (string)
    cdp-api will fill some value for old syndications with ScheduleType is not NoneType. '%Y-%M-%DT%h:%m:%s' is expected.

  - `data.attributes.endOn` (string)

  - `data.attributes.repeatUnit` (string)
    Setting an activation repetition cycle such as "day" or "week".
    Enum: "none", "minute", "hour", "day", "week", "month", "once"

  - `data.attributes.repeatFrequency` (integer)
    Setting an activation repeat frequency.
Currently, it is set only when the repeat unit is "minute". If the repeat unit is "minute", the interval is set in minutes.

  - `data.attributes.repeatSubFrequency` (array)
    Parameter for more detailed frequency settings. Values are array of integers.
Currently, this parameter is only valid for repeat unit "week".
For multiple days of the week, each value should be 1 to 7.
1: Monday, 2: Tuesday, 3: Wednesday, 4: Thursday, 5: Friday, 6: Saturday, 7: Sunday
    Example: [1,5,6]

  - `data.attributes.connectionId` (string)

  - `data.attributes.connectorConfig` (object)

  - `data.attributes.notifyOn` (array)

  - `data.attributes.emailRecipients` (array)

  - `data.attributes.createdAt` (string, required)

  - `data.attributes.updatedAt` (string, required)

  - `data.attributes.state` (string)
    Enum: "draft", "published"

  - `data.attributes.nestedWorkflowProjectName` (string)

  - `data.attributes.nestedWorkflowName` (string)

  - `data.attributes.activationActionsEnabled` (boolean)

  - `data.attributes.lockEnabled` (boolean)

  - `data.attributes.runAfterJourneyRefresh` (boolean)
    If true, this activation step will be executed immediately after the journey is refreshed. Only available for kind of journey.

  - `data.attributes.syndicationBehavior` (object)

  - `data.attributes.syndicationBehavior.behaviorTableName` (string)
    Behavior table name which contains behavior records
    Example: purchase_history

  - `data.attributes.syndicationBehavior.joinRow` (integer)
    How much rows would be joined (value is N for Top-N join)
    Example: 3

  - `data.attributes.syndicationBehavior.joinStrategy` (string)
    Enum: "All", "First", "Last", "Top-N"

  - `data.attributes.syndicationBehavior.formatting` (string)
    Enum: "rows", "cols"

  - `data.attributes.syndicationBehavior.orderBy` (array)
    Example: [{"key":"purchased_at","order":"descending"},{"key":"price","order":"ascending"}]

  - `data.attributes.syndicationBehavior.orderBy.key` (string)

  - `data.attributes.syndicationBehavior.orderBy.order` (string)
    Enum: "ascending", "descending"

  - `data.attributes.fieldProperties` (object)
    activation template field properties

  - `data.attributes.fieldProperties.locked` (object, required)
    activation template field properties locked

  - `data.attributes.fieldProperties.locked.allColumns` (boolean)

  - `data.attributes.fieldProperties.locked.columns` (object)
    Example: {"b24bf298-4f8c-4e8a-8187-38f2efc781d9":{"column":true,"source":true,"lockDeleteColumn":false},"c97c5711-31dd-4563-aca9-795c0b429593":{"column":true,"source":true,"lockDeleteColumn":false}}

  - `data.attributes.fieldProperties.locked.connectionId` (boolean)

  - `data.attributes.fieldProperties.locked.connectorConfig` (object)
    Example: {"userDatabaseName":true,"userTableName":true,"legacy":false,"mode":false}

  - `data.attributes.fieldProperties.locked.activationActionsEnabled` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior` (object)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.tableName` (string)
    Behavior table name which contains behavior records
    Example: purchase_history

  - `data.attributes.fieldProperties.locked.syndicationBehavior.columns` (object)
    Example: {"0ae6e876-9d9d-4217-8be2-f8646000d0c2":{"column":true,"source":true,"lockDeleteColumn":false},"b71d422e-4f29-47d5-b072-7e598275a402":{"column":true,"source":true,"lockDeleteColumn":false}}

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockAddColumn` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockDeleteBehaviorTable` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockEditBehaviorTable` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockEditJoinRow` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockEditJoinStrategy` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockEditFormatting` (boolean)

  - `data.attributes.fieldProperties.locked.syndicationBehavior.lockEditOrderBy` (boolean)

  - `data.attributes.fieldProperties.locked.lockAddColumn` (boolean)

  - `data.attributes.fieldProperties.locked.lockAddString` (boolean)

  - `data.attributes.fieldProperties.locked.lockAddBehavior` (boolean)

  - `data.attributes.fieldProperties.locked.lockEditSchedule` (boolean)

  - `data.attributes.fieldProperties.locked.lockEditNotification` (boolean)

  - `data.attributes.fieldProperties.locked.lockEditWorkflowExecution` (boolean)

  - `data.attributes.fieldProperties.locked.lockEditSequentialActivation` (boolean)

  - `data.attributes.activationCount` (integer)
    Number of related activations

  - `data.attributes.available` (boolean)
    This template is available or not (It contains PBP PII BLOCKED columns or not)

  - `data.attributes.availableBySegment` (boolean)
    This template is available by the segment or not (It return only with `availableBySegmentId` parameter)

  - `data.attributes.availableByStep` (boolean)
    This template is available by the step or not (It is returned only when `/entities/journeys/{journeyId}/activation_templates_for_step` is called)

  - `data.relationships` (object)

  - `data.relationships.parentFolder` (object)

  - `data.relationships.parentFolder.data` (object)

  - `data.relationships.parentFolder.data.id` (string, required)

  - `data.relationships.parentFolder.data.type` (string, required)
    Enum: "folder-segment"

  - `data.relationships.createdBy` (object)

  - `data.relationships.createdBy.data` (object)

  - `data.relationships.createdBy.data.id` (string, required)

  - `data.relationships.createdBy.data.type` (string, required)
    Enum: "user"

  - `included` (array, required)

  - `included.id` (string, required)

  - `included.type` (string, required)
    Enum: "user"

  - `included.attributes` (object, required)

  - `included.attributes.tdUserId` (string, required)

  - `included.attributes.name` (string, required)

