Retrieve

GET

jobs

{id}

Retrieve

curl --request GET \
  --url http://localhost:44442/api/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:44442/api/v1/jobs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "44442",
  CURLOPT_URL => "http://localhost:44442/api/v1/jobs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:44442/api/v1/jobs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:44442/api/v1/jobs/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "",
  "status": "working",
  "description": "",
  "tags": [],
  "priority": 50,
  "steps": [],
  "dependencies": [],
  "metadata": [],
  "notifications": [],
  "cleanup": {},
  "assets": [],
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "api_key_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "storage_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "icon": "<string>",
  "thumbnail": "<string>",
  "color": "<string>",
  "env": {
    "OCIO": "//studio/config/aces.ocio",
    "PATH": "$PATH;//studio/tools/bin"
  },
  "errors": [
    {}
  ],
  "schedule_date": 1785846207000,
  "created_at": 1785846207000,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "archived_at": 1785846207000,
  "removed_at": 1785846207000
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

An API key from Settings, API Keys. A caller on this machine needs none.

Path Parameters

string

required

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

Response

The job

string

required

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

name

string

default:""

required

status

enum<string>

required

Available options:

working,

finishing,

pending,

preparing,

submitting,

failed,

archived,

suspended,

scheduled,

queued,

completed,

disabled,

unknown

description

string

default:""

required

tags

string[]

required

priority

number

default:50

required

steps

object[]

required

Show child attributes

dependencies

object[]

required

Show child attributes

metadata

object[]

required

Show child attributes

notifications

object[]

required

Show child attributes

cleanup

object

required

Show child attributes

assets

object[]

required

Show child attributes

progress

object

required

Show child attributes

user_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

api_key_id

string | null

The API key that submitted it

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

pool_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

group_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

storage_id

string | null

Pattern: ^[a-fA-F0-9]{24}$

Example:

"68b1f0c2a4d3e5f6a7b8c9d0"

icon

string | null

thumbnail

string | null

color

string | null

env

object

Environment variables for every application the job starts, over the app's own. $NAME reads the value the app would have had.

Show child attributes

Example:

{
  "OCIO": "//studio/config/aces.ocio",
  "PATH": "$PATH;//studio/tools/bin"
}

errors

object[]

Show child attributes

schedule_date

integer | null

Example:

1785846207000

created_at

integer | null

Example:

1785846207000

started_at

integer | null

Example:

1785846207000

finished_at

integer | null

Example:

1785846207000

archived_at

integer | null

Example:

1785846207000

removed_at

integer | null

Example:

1785846207000

Retrieve

curl --request GET \
  --url http://localhost:44442/api/v1/jobs/{id} \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost:44442/api/v1/jobs/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "44442",
  CURLOPT_URL => "http://localhost:44442/api/v1/jobs/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:44442/api/v1/jobs/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("http://localhost:44442/api/v1/jobs/{id}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "name": "",
  "status": "working",
  "description": "",
  "tags": [],
  "priority": 50,
  "steps": [],
  "dependencies": [],
  "metadata": [],
  "notifications": [],
  "cleanup": {},
  "assets": [],
  "progress": {
    "percent": 123,
    "elapsed_time": 123,
    "remaining_time": 123,
    "total_render_time": 123,
    "average_time": 123,
    "info": "<string>"
  },
  "user_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "api_key_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "pool_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "group_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "storage_id": "68b1f0c2a4d3e5f6a7b8c9d0",
  "icon": "<string>",
  "thumbnail": "<string>",
  "color": "<string>",
  "env": {
    "OCIO": "//studio/config/aces.ocio",
    "PATH": "$PATH;//studio/tools/bin"
  },
  "errors": [
    {}
  ],
  "schedule_date": 1785846207000,
  "created_at": 1785846207000,
  "started_at": 1785846207000,
  "finished_at": 1785846207000,
  "archived_at": 1785846207000,
  "removed_at": 1785846207000
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

{
  "error": "<string>",
  "tag": "<string>",
  "title": "<string>",
  "detail": "<string>",
  "issues": [
    {
      "path": [
        "<string>"
      ],
      "message": "<string>"
    }
  ]
}

Overview

Getting Started

Guides

Scripting

Developers

API Reference

Support

Resources

Authorizations

Path Parameters

Response