Create an Activation Template

Request

Request Body schema: application/vnd.treasuredata.v1+json

id	string[1-9][0-9]*
type	string Value: "activation-template"
	object (ActivationTemplateJsonApiParameters)
	object

Responses

200

Created Activation Template

400

Given parameters are not valid

403

Requested resource or action is not allowed because you don't have sufficient permissions

404

The specified resource is not found

5XX

System error. Because there is a possibility of a temporary error due to network trouble and so on, we recommend several times retry on request side. Please contact the TD support team if you do not resolve it.

post/entities/activation_templates

Request samples

Payload
curl
JS

application/vnd.treasuredata.v1+json

{"id": "string",
"type": "activation-template",
"attributes": {"name": "string",
"description": "string",
"allColumns": true,
"columns": [{"column": "alias_name",
"source": {"column": "real_column_name"
}
}
],
"scheduleType": "daily",
"scheduleOption": "string",
"timezone": "string",
"startAt": "string",
"endOn": "2019-08-24",
"repeatUnit": "none",
"repeatFrequency": 1,
"repeatSubFrequency": [1,
5,
6
],
"connectionId": 0,
"connectorConfig": { },
"notifyOn": ["onSuccess"
],
"emailRecipients": [0
],
"state": "draft",
"nestedWorkflowProjectName": "string",
"nestedWorkflowName": "string",
"lockEnabled": true,
"fieldProperties": {"locked": {"allColumns": true,
"columns": {"b24bf298-4f8c-4e8a-8187-38f2efc781d9": {"column": true,
"source": true,
"lockDeleteColumn": false
},
"c97c5711-31dd-4563-aca9-795c0b429593": {"column": true,
"source": true,
"lockDeleteColumn": false
}
},
"connectionId": true,
"connectorConfig": {"userDatabaseName": true,
"userTableName": true,
"legacy": false,
"mode": false
},
"activationActionsEnabled": true,
"lockAddColumn": true,
"lockAddString": true,
"lockEditSchedule": true,
"lockEditNotification": true,
"lockEditWorkflowExecution": true,
"lockEditSequentialActivation": true
}
}
},
"relationships": {"parentFolder": {"data": {"id": "string",
"type": "folder-segment"
}
}
}
}

Response samples

application/json

{"data": {"id": "string",
"type": "activation-template",
"attributes": {"audienceId": "string",
"name": "string",
"description": "string",
"allColumns": true,
"columns": [{"column": "alias_name",
"source": {"column": "real_column_name"
}
}
],
"scheduleType": "daily",
"scheduleOption": "string",
"timezone": "string",
"startAt": "string",
"endOn": "2019-08-24",
"repeatUnit": "none",
"repeatFrequency": 1,
"repeatSubFrequency": [1,
5,
6
],
"connectionId": "string",
"connectorConfig": { },
"notifyOn": ["onSuccess"
],
"emailRecipients": [0
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"state": "draft",
"nestedWorkflowProjectName": "string",
"nestedWorkflowName": "string",
"activationActionsEnabled": true,
"lockEnabled": true,
"fieldProperties": {"locked": {"allColumns": true,
"columns": {"b24bf298-4f8c-4e8a-8187-38f2efc781d9": {"column": true,
"source": true,
"lockDeleteColumn": false
},
"c97c5711-31dd-4563-aca9-795c0b429593": {"column": true,
"source": true,
"lockDeleteColumn": false
}
},
"connectionId": true,
"connectorConfig": {"userDatabaseName": true,
"userTableName": true,
"legacy": false,
"mode": false
},
"activationActionsEnabled": true,
"lockAddColumn": true,
"lockAddString": true,
"lockEditSchedule": true,
"lockEditNotification": true,
"lockEditWorkflowExecution": true,
"lockEditSequentialActivation": true
}
},
"activationCount": 0,
"available": true
},
"relationships": {"parentFolder": {"data": {"id": "string",
"type": "folder-segment"
}
},
"createdBy": {"data": {"id": "string",
"type": "user"
}
},
"updatedBy": {"data": {"id": "string",
"type": "user"
}
}
}
},
"included": [{"id": "string",
"type": "user",
"attributes": {"tdUserId": "string",
"name": "string"
}
}
]
}