Status

Jobs API provides status of all user initiated jobs in FileSpin.

/jobs/{job_id} API returns the status of a job.

RESPONSE JSON

The API call will return with a JSON response as below.

 {
  "status": "COMPLETED",
  "message": "",
  "job_id": 1234,
  "creator_id": 272,
  "requested_at": "2017-04-20T16:08:02Z",
  "completed_at": "2017-04-20T16:08:02Z",
  "job_steps": {
  },
  "input": {},
  "callback": {},
  "type": "VIDEO_TRANSCODE"
}

RESPONSE PARAMETERS

Key	Value	Description
`status`	string	Can be `"QUEUED"`, `"IN_PROGRESS"`, `"COMPLETED"`, `"ERROR"`
`message`	string	On `"ERROR"` status, this will contain the error message that can be used to diagnose the error
`job_id`	integer	The job ID to track the job
`creator_id`	integer	Id of the user who initiated the job
`requested_at`	string	ISO 8601 datetime, time at which the job request was received
`completed_at`	string	ISO 8601 datetime, time at which the job completed
`job_steps`	JSON	The job steps and step completion timestamps. This is useful for monitoring progress. The steps will vary depending on the job type.
`input`	JSON	The API request JSON that created this job
`callback`	JSON	The callback JSON issued if job completed. If job is not completed yet, this will be an empty dictionary
`type`	string	The job type. Only `"VIDEO_TRANSCODE"` supported at this time

Steps for Video Transcode Job

The job_steps for VIDEO_TRANSCODE job type is as below:-

{
   "transcodes": {
          "480p-video": {
              "status": "COMPLETED",
              "percent_complete": 100,
              "started_at": "2023-07-18T15:09:24Z",
              "finished_at": "2023-07-18T15:09:28Z",
              "message": ""
          }
      },
     "addons": {
           "storyboard": {
               "status": "COMPLETED",
               "percent_complete": 100,
               "started_at": "2023-07-18T15:06:12Z",
               "finished_at": "2023-07-18T15:08:46Z",
               "message": ""
           }
       },
      "preprocess": {
          "status": "COMPLETED",
          "percent_complete": 100,
          "started_at": "2023-07-18T15:09:24Z",
          "finished_at": "2023-07-18T15:09:25Z",
          "message": "Downloaded & verified integrity of input file test.mov"
      },
      "postprocess": {
          "status": "COMPLETED",
          "percent_complete": 100,
          "started_at": "2023-07-18T15:09:26Z",
          "finished_at": "2023-07-18T15:09:28Z",
          "message": "Completed uploading outputs"
      }
}

Key	Value	Description
`status`	string	Can be `"QUEUED"`,`"IN_PROGRESS"`, `"COMPLETED"`, `"ERROR"`
`message`	string	On `"ERROR"` status, this will contain the error message that can be used to diagnose the error
`percent_complete`	integer	Job progress as percentage value
`started_at`	string	ISO 8601 datetime, time at which the step processing was started
`finished_at`	string	ISO 8601 datetime, time at which the step completed