The Open API specification for Synapse is now available for download!

Download Open API Spec

AsynchronousJobStatus

org.sagebionetworks.repo.model.asynch.AsynchronousJobStatus

Object used to track the status of an Asynchronous Job.

Field Type Description
jobState AsynchJobState The job's state can be one of the following enumerations
jobCanceling BOOLEAN Was the job being asked to cancel.
requestBody AsynchronousRequestBody The body of an Asynchronous job request.
responseBody AsynchronousResponseBody The body of an Asynchronous job response.
etag STRING The etag of the status will change whenever the status changes.
jobId STRING The ID if the job issued when this job request was issued.
startedByUserId INTEGER The ID of the user that started the job
startedOn STRING The date-time when the status of this table last changed to PROCESSING.
changedOn STRING The date-time when the status of this table last changed.
progressMessage STRING The current message of the progress tracker.
progressCurrent INTEGER The progress current value indicates how much progress has been made. For example: If progressTotal = 100; and progressCurrent = 50; then the work is 50% complete.
progressTotal INTEGER The progress total indicates the total amount of work to complete. For example: If progressTotal = 100; and progressCurrent = 50; then the work is 50% complete.
exception STRING The exception that needs to be thrown
errorMessage STRING When processing fails, this is a one line error message.
errorDetails STRING When processing fails, this is the full stack trace of the error.
runtimeMS INTEGER The number of milliseconds from the start to completion of this job.
callersContext CallersContext Contextual information about a web service call.