Sign in

v1

latestOpenAPI 3.0.02026-07-2480355389.7 KB
Comments

Create a new comment with new comment thread

Start a new comment thread on a dataset item and creates first comment.

post/api/v2/teams/{team_slug}/items/{dataset_item_id}/comment_threads

Path parameters

team_slugstring required

Team's sluggified name

dataset_item_idstring uuid required
Example:e23ff3f3-8f77-4e78-9e81-fdb25abfb781

Request body

issue_typesCommentsCommentThreadIssueType[] nullable
section_indexinteger nullable
slot_namestring required

Example request

{
  "issue_data": {
    "annotation_ids": [
      "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    ],
    "disagreement": {
      "ious": [
        {
          "champion_annotation_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "other_annotation_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ]
    },
    "disagreement_item_property": {
      "champion_annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "choices_by_group": [
        {
          "annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "model_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "property_value_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "majority_property_value_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "property_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    },
    "disagreement_tag": {
      "annotation_actors": [
        {
          "model_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "not_added_by_annotation_actors": [
        {
          "model_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ]
    }
  }
}

Response

Comments.CommentThread.CommentThread

author_idinteger required
comment_countinteger nullable
dataset_item_idstring uuid required
idstring uuid required
inserted_atstring required
issue_typesCommentsCommentThreadIssueType[] nullable required
last_comment_atstring nullable required

Creation dt of the last comment in the thread.

resolvedboolean required
section_indexinteger nullable required
slot_namestring required
updated_atstring required

Example response

{
  "dataset_item_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "first_comment": {
    "comment_thread_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
    "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
  },
  "id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
  "issue_data": {
    "annotation_ids": [
      "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    ],
    "disagreement": {
      "ious": [
        {
          "champion_annotation_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "other_annotation_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ]
    },
    "disagreement_item_property": {
      "champion_annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "choices_by_group": [
        {
          "annotation_group_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "model_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
          "property_value_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "majority_property_value_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781",
      "property_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
    },
    "disagreement_tag": {
      "annotation_actors": [
        {
          "model_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ],
      "not_added_by_annotation_actors": [
        {
          "model_id": "e23ff3f3-8f77-4e78-9e81-fdb25abfb781"
        }
      ]
    }
  }
}