POST /import/shotgun/notes

Import Shotgun notes (comments) linked to tasks. Send a list of Shotgun note entries in the JSON body. Only notes linked to tasks are imported. Returns created or updated comments.

application/json

Body Required

  • id integer

    Shotgun ID of the note

  • content string

    Note content

  • tasks array[object]

    Linked tasks

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

    User who created the note

    Hide user attribute Show user attribute object
    • id integer
  • created_at string(date-time)

    Creation timestamp

Responses

  • 200 application/json

    Notes imported successfully

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

      Comment unique identifier

    • text string

      Comment text

    • created_at string(date-time)

      Creation timestamp

  • 400

    Invalid request body or data format error

POST /import/shotgun/notes
curl -X POST "http://api.example.com/import/shotgun/notes" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '[
  {
    "id": 12345,
    "content": "This is a comment",
    "tasks": [
      {
        "id": 67890
      }
    ],
    "user": {
      "id": 11111
    },
    "created_at": "2024-01-15T10:30:00Z"
  }
]'
import requests

url = "http://api.example.com/import/shotgun/notes"
headers = {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
}
params = {}
payload = [
    {
        "id": 12345,
        "content": "This is a comment",
        "tasks": [
            {
                "id": 67890
            }
        ],
        "user": {
            "id": 11111
        },
        "created_at": "2024-01-15T10:30:00Z"
    }
]

response = requests.post(
    url,
    headers=headers,
    params=params,
    json=payload
)

response.raise_for_status()

if response.content:
    print(response.json())
curl \
 --request POST 'http://api.example.com/import/shotgun/notes' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '[{"id":12345,"user":{"id":11111},"tasks":[{"id":67890}],"content":"This is a comment","created_at":"2024-01-15T10:30:00Z"}]'
Request example
[
  {
    "id": 12345,
    "user": {
      "id": 11111
    },
    "tasks": [
      {
        "id": 67890
      }
    ],
    "content": "This is a comment",
    "created_at": "2024-01-15T10:30:00Z"
  }
]
Response examples (200)
[
  {
    "id": "a24a6ea4-ce75-4665-a070-57453082c25",
    "text": "This is a comment",
    "created_at": "2024-01-15T10:30:00Z"
  }
]