Workflow traces

Manage workflow execution (pipeline run) traces.

Path and query parameters

Name	Type	Location	Req/Opt	Description
workspaceId	integer	query	Optional	Workspace numeric identifier.
workflowId	string	path	Required	Workflow string identifier.

Request body parameters

Name	Type	Req/Opt	Description
CreateTrace			Create workflow execution trace
launchId	string	Optional
sessionId	string	Optional
runName	string	Optional
projectName	string	Optional
repository	string	Optional
workflowId	string	Optional
UpdateTraceBegin			Signal workflow execution start
launchId	string	Optional
workflow	object	Optional
workflow.requiresAttention	boolean	Optional
workflow.status	string	Optional
workflow.ownerId	integer	Optional
workflow.repository	string	Optional
workflow.id	string	Optional
workflow.submit	string	Required
workflow.start	string	Optional
workflow.complete	string	Optional
workflow.dateCreated	string	Optional
workflow.lastUpdated	string	Optional
workflow.runName	string	Required
workflow.sessionId	string	Required
workflow.profile	string	Optional
workflow.workDir	string	Required
workflow.commitId	string	Optional
workflow.userName	string	Required
workflow.scriptId	string	Optional
workflow.revision	string	Optional
workflow.commandLine	string	Required
workflow.projectName	string	Required
workflow.scriptName	string	Optional
workflow.launchId	string	Optional
workflow.configFiles	array	Optional
workflow.params	object	Optional
workflow.configText	string	Optional
workflow.manifest	object	Optional
workflow.manifest.nextflowVersion	string	Optional
workflow.manifest.defaultBranch	string	Optional
workflow.manifest.version	string	Optional
workflow.manifest.homePage	string	Optional
workflow.manifest.gitmodules	string	Optional
workflow.manifest.description	string	Optional
workflow.manifest.name	string	Optional
workflow.manifest.mainScript	string	Optional
workflow.manifest.author	string	Optional
workflow.manifest.icon	string	Optional
workflow.nextflow	object	Optional
workflow.nextflow.version	string	Optional
workflow.nextflow.build	string	Optional
workflow.nextflow.timestamp	string	Optional
workflow.stats	object	Optional
workflow.stats.computeTimeFmt	string	Optional
workflow.stats.cachedCount	integer	Optional
workflow.stats.failedCount	integer	Optional
workflow.stats.ignoredCount	integer	Optional
workflow.stats.succeedCount	integer	Optional
workflow.stats.cachedCountFmt	string	Optional
workflow.stats.succeedCountFmt	string	Optional
workflow.stats.failedCountFmt	string	Optional
workflow.stats.ignoredCountFmt	string	Optional
workflow.stats.cachedPct	number	Optional
workflow.stats.failedPct	number	Optional
workflow.stats.succeedPct	number	Optional
workflow.stats.ignoredPct	number	Optional
workflow.stats.cachedDuration	integer	Optional
workflow.stats.failedDuration	integer	Optional
workflow.stats.succeedDuration	integer	Optional
workflow.errorMessage	string	Optional
workflow.errorReport	string	Optional
workflow.deleted	boolean	Optional
workflow.projectDir	string	Optional
workflow.homeDir	string	Optional
workflow.container	string	Optional
workflow.containerEngine	string	Optional
workflow.scriptFile	string	Optional
workflow.launchDir	string	Optional
workflow.duration	integer	Optional
workflow.exitStatus	integer	Optional
workflow.resume	boolean	Optional
workflow.success	boolean	Optional
workflow.logFile	string	Optional
workflow.outFile	string	Optional
workflow.operationId	string	Optional
processNames	array	Optional
towerLaunch	boolean	Optional
UpdateTraceComplete			Signal workflow execution completion
workflow	object	Optional
workflow.requiresAttention	boolean	Optional
workflow.status	string	Optional
workflow.ownerId	integer	Optional
workflow.repository	string	Optional
workflow.id	string	Optional
workflow.submit	string	Required
workflow.start	string	Optional
workflow.complete	string	Optional
workflow.dateCreated	string	Optional
workflow.lastUpdated	string	Optional
workflow.runName	string	Required
workflow.sessionId	string	Required
workflow.profile	string	Optional
workflow.workDir	string	Required
workflow.commitId	string	Optional
workflow.userName	string	Required
workflow.scriptId	string	Optional
workflow.revision	string	Optional
workflow.commandLine	string	Required
workflow.projectName	string	Required
workflow.scriptName	string	Optional
workflow.launchId	string	Optional
workflow.configFiles	array	Optional
workflow.params	object	Optional
workflow.configText	string	Optional
workflow.manifest	object	Optional
workflow.manifest.nextflowVersion	string	Optional
workflow.manifest.defaultBranch	string	Optional
workflow.manifest.version	string	Optional
workflow.manifest.homePage	string	Optional
workflow.manifest.gitmodules	string	Optional
workflow.manifest.description	string	Optional
workflow.manifest.name	string	Optional
workflow.manifest.mainScript	string	Optional
workflow.manifest.author	string	Optional
workflow.manifest.icon	string	Optional
workflow.nextflow	object	Optional
workflow.nextflow.version	string	Optional
workflow.nextflow.build	string	Optional
workflow.nextflow.timestamp	string	Optional
workflow.stats	object	Optional
workflow.stats.computeTimeFmt	string	Optional
workflow.stats.cachedCount	integer	Optional
workflow.stats.failedCount	integer	Optional
workflow.stats.ignoredCount	integer	Optional
workflow.stats.succeedCount	integer	Optional
workflow.stats.cachedCountFmt	string	Optional
workflow.stats.succeedCountFmt	string	Optional
workflow.stats.failedCountFmt	string	Optional
workflow.stats.ignoredCountFmt	string	Optional
workflow.stats.cachedPct	number	Optional
workflow.stats.failedPct	number	Optional
workflow.stats.succeedPct	number	Optional
workflow.stats.ignoredPct	number	Optional
workflow.stats.cachedDuration	integer	Optional
workflow.stats.failedDuration	integer	Optional
workflow.stats.succeedDuration	integer	Optional
workflow.errorMessage	string	Optional
workflow.errorReport	string	Optional
workflow.deleted	boolean	Optional
workflow.projectDir	string	Optional
workflow.homeDir	string	Optional
workflow.container	string	Optional
workflow.containerEngine	string	Optional
workflow.scriptFile	string	Optional
workflow.launchDir	string	Optional
workflow.duration	integer	Optional
workflow.exitStatus	integer	Optional
workflow.resume	boolean	Optional
workflow.success	boolean	Optional
workflow.logFile	string	Optional
workflow.outFile	string	Optional
workflow.operationId	string	Optional
metrics	array	Optional
metrics[].id	integer	Optional
metrics[].process	string	Required
metrics[].cpu	object	Optional
metrics[].cpu.warnings	array	Optional
metrics[].cpu.mean	number	Optional
metrics[].cpu.min	number	Optional
metrics[].cpu.q1	number	Optional
metrics[].cpu.q2	number	Optional
metrics[].cpu.q3	number	Optional
metrics[].cpu.max	number	Optional
metrics[].cpu.minLabel	string	Optional
metrics[].cpu.maxLabel	string	Optional
metrics[].cpu.q1Label	string	Optional
metrics[].cpu.q2Label	string	Optional
metrics[].cpu.q3Label	string	Optional
metrics[].mem	object	Optional
metrics[].mem.warnings	array	Optional
metrics[].mem.mean	number	Optional
metrics[].mem.min	number	Optional
metrics[].mem.q1	number	Optional
metrics[].mem.q2	number	Optional
metrics[].mem.q3	number	Optional
metrics[].mem.max	number	Optional
metrics[].mem.minLabel	string	Optional
metrics[].mem.maxLabel	string	Optional
metrics[].mem.q1Label	string	Optional
metrics[].mem.q2Label	string	Optional
metrics[].mem.q3Label	string	Optional
metrics[].vmem	object	Optional
metrics[].vmem.warnings	array	Optional
metrics[].vmem.mean	number	Optional
metrics[].vmem.min	number	Optional
metrics[].vmem.q1	number	Optional
metrics[].vmem.q2	number	Optional
metrics[].vmem.q3	number	Optional
metrics[].vmem.max	number	Optional
metrics[].vmem.minLabel	string	Optional
metrics[].vmem.maxLabel	string	Optional
metrics[].vmem.q1Label	string	Optional
metrics[].vmem.q2Label	string	Optional
metrics[].vmem.q3Label	string	Optional
metrics[].time	object	Optional
metrics[].time.warnings	array	Optional
metrics[].time.mean	number	Optional
metrics[].time.min	number	Optional
metrics[].time.q1	number	Optional
metrics[].time.q2	number	Optional
metrics[].time.q3	number	Optional
metrics[].time.max	number	Optional
metrics[].time.minLabel	string	Optional
metrics[].time.maxLabel	string	Optional
metrics[].time.q1Label	string	Optional
metrics[].time.q2Label	string	Optional
metrics[].time.q3Label	string	Optional
metrics[].reads	object	Optional
metrics[].reads.warnings	array	Optional
metrics[].reads.mean	number	Optional
metrics[].reads.min	number	Optional
metrics[].reads.q1	number	Optional
metrics[].reads.q2	number	Optional
metrics[].reads.q3	number	Optional
metrics[].reads.max	number	Optional
metrics[].reads.minLabel	string	Optional
metrics[].reads.maxLabel	string	Optional
metrics[].reads.q1Label	string	Optional
metrics[].reads.q2Label	string	Optional
metrics[].reads.q3Label	string	Optional
metrics[].writes	object	Optional
metrics[].writes.warnings	array	Optional
metrics[].writes.mean	number	Optional
metrics[].writes.min	number	Optional
metrics[].writes.q1	number	Optional
metrics[].writes.q2	number	Optional
metrics[].writes.q3	number	Optional
metrics[].writes.max	number	Optional
metrics[].writes.minLabel	string	Optional
metrics[].writes.maxLabel	string	Optional
metrics[].writes.q1Label	string	Optional
metrics[].writes.q2Label	string	Optional
metrics[].writes.q3Label	string	Optional
metrics[].cpuUsage	object	Optional
metrics[].cpuUsage.warnings	array	Optional
metrics[].cpuUsage.mean	number	Optional
metrics[].cpuUsage.min	number	Optional
metrics[].cpuUsage.q1	number	Optional
metrics[].cpuUsage.q2	number	Optional
metrics[].cpuUsage.q3	number	Optional
metrics[].cpuUsage.max	number	Optional
metrics[].cpuUsage.minLabel	string	Optional
metrics[].cpuUsage.maxLabel	string	Optional
metrics[].cpuUsage.q1Label	string	Optional
metrics[].cpuUsage.q2Label	string	Optional
metrics[].cpuUsage.q3Label	string	Optional
metrics[].memUsage	object	Optional
metrics[].memUsage.warnings	array	Optional
metrics[].memUsage.mean	number	Optional
metrics[].memUsage.min	number	Optional
metrics[].memUsage.q1	number	Optional
metrics[].memUsage.q2	number	Optional
metrics[].memUsage.q3	number	Optional
metrics[].memUsage.max	number	Optional
metrics[].memUsage.minLabel	string	Optional
metrics[].memUsage.maxLabel	string	Optional
metrics[].memUsage.q1Label	string	Optional
metrics[].memUsage.q2Label	string	Optional
metrics[].memUsage.q3Label	string	Optional
metrics[].timeUsage	object	Optional
metrics[].timeUsage.warnings	array	Optional
metrics[].timeUsage.mean	number	Optional
metrics[].timeUsage.min	number	Optional
metrics[].timeUsage.q1	number	Optional
metrics[].timeUsage.q2	number	Optional
metrics[].timeUsage.q3	number	Optional
metrics[].timeUsage.max	number	Optional
metrics[].timeUsage.minLabel	string	Optional
metrics[].timeUsage.maxLabel	string	Optional
metrics[].timeUsage.q1Label	string	Optional
metrics[].timeUsage.q2Label	string	Optional
metrics[].timeUsage.q3Label	string	Optional
progress	object	Optional
progress.pending	integer	Optional
progress.submitted	integer	Optional
progress.running	integer	Optional
progress.succeeded	integer	Optional
progress.cached	integer	Optional
progress.failed	integer	Optional
progress.aborted	integer	Optional
progress.stored	integer	Optional
progress.ignored	integer	Optional
progress.retries	integer	Optional
progress.loadCpus	integer	Optional
progress.loadMemory	integer	Optional
progress.peakRunning	integer	Optional
progress.peakCpus	integer	Optional
progress.peakMemory	integer	Optional
progress.processes	array	Optional
progress.processes[].index	integer	Optional
progress.processes[].name	string	Optional
progress.processes[].pending	integer	Optional
progress.processes[].submitted	integer	Optional
progress.processes[].running	integer	Optional
progress.processes[].succeeded	integer	Optional
progress.processes[].cached	integer	Optional
progress.processes[].failed	integer	Optional
progress.processes[].aborted	integer	Optional
progress.processes[].stored	integer	Optional
progress.processes[].ignored	integer	Optional
progress.processes[].retries	integer	Optional
progress.processes[].terminated	boolean	Optional
progress.processes[].loadCpus	integer	Optional
progress.processes[].loadMemory	integer	Optional
progress.processes[].peakRunning	integer	Optional
progress.processes[].peakCpus	integer	Optional
progress.processes[].peakMemory	integer	Optional
UpdateTraceHeartbeat			Signal workflow execution heartbeat
progress	object	Optional
progress.pending	integer	Optional
progress.submitted	integer	Optional
progress.running	integer	Optional
progress.succeeded	integer	Optional
progress.cached	integer	Optional
progress.failed	integer	Optional
progress.aborted	integer	Optional
progress.stored	integer	Optional
progress.ignored	integer	Optional
progress.retries	integer	Optional
progress.loadCpus	integer	Optional
progress.loadMemory	integer	Optional
progress.peakRunning	integer	Optional
progress.peakCpus	integer	Optional
progress.peakMemory	integer	Optional
progress.processes	array	Optional
progress.processes[].index	integer	Optional
progress.processes[].name	string	Optional
progress.processes[].pending	integer	Optional
progress.processes[].submitted	integer	Optional
progress.processes[].running	integer	Optional
progress.processes[].succeeded	integer	Optional
progress.processes[].cached	integer	Optional
progress.processes[].failed	integer	Optional
progress.processes[].aborted	integer	Optional
progress.processes[].stored	integer	Optional
progress.processes[].ignored	integer	Optional
progress.processes[].retries	integer	Optional
progress.processes[].terminated	boolean	Optional
progress.processes[].loadCpus	integer	Optional
progress.processes[].loadMemory	integer	Optional
progress.processes[].peakRunning	integer	Optional
progress.processes[].peakCpus	integer	Optional
progress.processes[].peakMemory	integer	Optional
UpdateTraceProgress			Store workflow task execution metadata
tasks	array	Optional
tasks[].hash	string	Optional
tasks[].name	string	Optional
tasks[].process	string	Optional
tasks[].tag	string	Optional
tasks[].submit	string	Optional
tasks[].start	string	Optional
tasks[].complete	string	Optional
tasks[].module	array	Optional
tasks[].container	string	Optional
tasks[].attempt	integer	Optional
tasks[].script	string	Optional
tasks[].scratch	string	Optional
tasks[].workdir	string	Optional
tasks[].queue	string	Optional
tasks[].cpus	integer	Optional
tasks[].memory	integer	Optional
tasks[].disk	integer	Optional
tasks[].time	integer	Optional
tasks[].env	string	Optional
tasks[].executor	string	Optional
tasks[].machineType	string	Optional
tasks[].cloudZone	string	Optional
tasks[].priceModel	string	Optional
tasks[].cost	number	Optional
tasks[].errorAction	string	Optional
tasks[].exitStatus	integer	Optional
tasks[].duration	integer	Optional
tasks[].realtime	integer	Optional
tasks[].nativeId	string	Optional
tasks[].pcpu	number	Optional
tasks[].pmem	number	Optional
tasks[].rss	integer	Optional
tasks[].vmem	integer	Optional
tasks[].peakRss	integer	Optional
tasks[].peakVmem	integer	Optional
tasks[].rchar	integer	Optional
tasks[].wchar	integer	Optional
tasks[].syscr	integer	Optional
tasks[].syscw	integer	Optional
tasks[].readBytes	integer	Optional
tasks[].writeBytes	integer	Optional
tasks[].volCtxt	integer	Optional
tasks[].invCtxt	integer	Optional
tasks[].exit	integer	Optional
tasks[].id	integer	Optional
tasks[].taskId	integer	Required
tasks[].status	string	Required
tasks[].dateCreated	string	Optional
tasks[].lastUpdated	string	Optional
progress	object	Optional
progress.pending	integer	Optional
progress.submitted	integer	Optional
progress.running	integer	Optional
progress.succeeded	integer	Optional
progress.cached	integer	Optional
progress.failed	integer	Optional
progress.aborted	integer	Optional
progress.stored	integer	Optional
progress.ignored	integer	Optional
progress.retries	integer	Optional
progress.loadCpus	integer	Optional
progress.loadMemory	integer	Optional
progress.peakRunning	integer	Optional
progress.peakCpus	integer	Optional
progress.peakMemory	integer	Optional
progress.processes	array	Optional
progress.processes[].index	integer	Optional
progress.processes[].name	string	Optional
progress.processes[].pending	integer	Optional
progress.processes[].submitted	integer	Optional
progress.processes[].running	integer	Optional
progress.processes[].succeeded	integer	Optional
progress.processes[].cached	integer	Optional
progress.processes[].failed	integer	Optional
progress.processes[].aborted	integer	Optional
progress.processes[].stored	integer	Optional
progress.processes[].ignored	integer	Optional
progress.processes[].retries	integer	Optional
progress.processes[].terminated	boolean	Optional
progress.processes[].loadCpus	integer	Optional
progress.processes[].loadMemory	integer	Optional
progress.processes[].peakRunning	integer	Optional
progress.processes[].peakCpus	integer	Optional
progress.processes[].peakMemory	integer	Optional
containers	array	Optional
containers[].requestId	string	Optional
containers[].sourceImage	string	Optional
containers[].targetImage	string	Required
containers[].buildId	string	Optional
containers[].scanId	string	Optional
containers[].mirrorId	string	Optional
containers[].cached	boolean	Optional
containers[].freeze	boolean	Optional
containers[].requestTime	string	Optional