Appendix C: Object Definitions

ETLTemplate

Name Type Description
id string The template ID.
name string The template name.
lastRunTime long The last time the template ran (Unix Time in milliseconds). A value of null means the template has never been run.
modelId string ID of the model associated with the template.
modelName string Name of the model associated with the template.

ETLTemplateWithSteps

Name Type Description
id string The template ID.
name string The template name.
lastRunTime long The last time the template ran (Unix Time in milliseconds). A value of null means the template has never been run.
modelId string ID of the model associated with the template.
modelName string Name of the model associated with the template.
steps ETLStep [] List of template steps

ETLStep

Name Type Description
stepName string The name of the step.
dataType string The type of data being processed.
inputId string The input ID to use when uploading data to the job.

ETLJob

Name Type Description
id string The job ID.
name string The job name.
status ETLJobStatus The current status of the job.
modelId string ID of the model associated with the job.
modelName string Name of the model associated with the job.
createdDate long When the job was created (Unix Time in milliseconds).
updatedDate long When the job was last updated (Unix Time in milliseconds). A value of null means the job has never been updated.
userName string Name of the user who created the job.

ETLJobStatus

Value Description
"EDITING" The ETL job properties are being updated. For example, data is being added to the job ETL steps.
"NOT_STARTED" ETL job is ready to run.
"SUBMITTED" ETL job is ready to run.
"RUNNING" ETL job is executing.
"COMPLETED" Execution of ETL job completed successfully.
"ERROR" Execution of ETL job failed.
"CANCELLED" Execution of ETL job was cancelled.
"WAITING" ETL job is waiting to be executed.
"QUEUED" ETL job is lined up for execution.
"EXPIRED" ETL job can no longer be executed. It was in "EDITING" state for too long.