Import shotgun versions

POST /import/shotgun/versions
Jwt authorization

Import Shotgun versions (preview files). Send a list of Shotgun version entries in the JSON body. Only versions linked to tasks are imported. Returns created or updated preview files.

application/json

Body Required

  • id integer

    Shotgun ID of the version

  • code string

    Version code

  • description string

    Version description

  • sg_task object

    Task information

    Hide sg_task attribute Show sg_task attribute object
    • id integer
  • user object

    User information

    Hide user attribute Show user attribute object
    • id integer
  • sg_uploaded_movie object

    Uploaded movie information

    Hide sg_uploaded_movie attributes Show sg_uploaded_movie attributes object
    • url string
    • name string

Responses

  • 200 application/json

    Versions imported successfully

    Hide response attributes Show response attributes object
    • id string(uuid)

      Preview file unique identifier

    • name string

      Preview file name

    • description string

      Preview file description

    • source string

      Source of the preview

    • created_at string(date-time)

      Creation timestamp

    • updated_at string(date-time)

      Update timestamp
  • 400

    Invalid request body or data format error

POST /import/shotgun/versions 
curl \
 --request POST 'http://api.example.com/import/shotgun/versions' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"id":12345,"code":"v001","user":{"id":22222},"sg_task":{"id":11111},"description":"First version","sg_uploaded_movie":{"url":"https://example.com/movie.mp4","name":"movie.mp4"}}]'
Request example 
[
  {
    "id": 12345,
    "code": "v001",
    "user": {
      "id": 22222
    },
    "sg_task": {
      "id": 11111
    },
    "description": "First version",
    "sg_uploaded_movie": {
      "url": "https://example.com/movie.mp4",
      "name": "movie.mp4"
    }
  }
]
Response examples (200) 
[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "v001",
    "description": "First version",
    "source": "Shotgun",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T11:00:00Z"
  }
]