Import shotgun tasks

POST /import/shotgun/tasks

Import Shotgun tasks. Send a list of Shotgun task entries in the JSON body. Only tasks with steps and projects are imported. Returns created or updated tasks with assignees.

application/json

Body Required

  • id integer

    Shotgun ID of the task

  • cached_display_name string

    Task display name

  • start_date string(date)

    Start date

  • due_date string(date)

    Due date

  • sg_sort_order integer

    Sort order

  • duration integer

    Duration in days

  • step object

    Step (task type) information

    Hide step attribute Show step attribute object
    • id integer
  • project object

    Project information

    Hide project attribute Show project attribute object
    • id integer
  • entity object

    Entity information

    Hide entity attributes Show entity attributes object
    • id integer
    • type string
  • sg_status_list string

    Status short name

  • created_by object

    Creator information

    Hide created_by attribute Show created_by attribute object
    • id integer
  • task_assignees array[object]

    Task assignees

    Hide task_assignees attribute Show task_assignees attribute object
    • id integer

Responses

  • 200 application/json

    Tasks imported successfully

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

      Task unique identifier

    • name string

      Task name

    • start_date string(date)

      Start date

    • due_date string(date)

      Due date

    • 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/tasks
curl \
 --request POST 'http://api.example.com/import/shotgun/tasks' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"id":12345,"step":{"id":11111},"entity":{"id":33333,"type":"Asset"},"project":{"id":22222},"due_date":"2024-02-15","duration":30,"created_by":{"id":44444},"start_date":"2024-01-15","sg_sort_order":1,"sg_status_list":"IP","task_assignees":[{"id":55555}],"cached_display_name":"Modeling for Asset"}]'
Request example
[
  {
    "id": 12345,
    "step": {
      "id": 11111
    },
    "entity": {
      "id": 33333,
      "type": "Asset"
    },
    "project": {
      "id": 22222
    },
    "due_date": "2024-02-15",
    "duration": 30,
    "created_by": {
      "id": 44444
    },
    "start_date": "2024-01-15",
    "sg_sort_order": 1,
    "sg_status_list": "IP",
    "task_assignees": [
      {
        "id": 55555
      }
    ],
    "cached_display_name": "Modeling for Asset"
  }
]
Response examples (200)
[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "name": "Modeling for Asset",
    "start_date": "2024-01-15",
    "due_date": "2024-02-15",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T11:00:00Z"
  }
]