Comments

Manage comments and replies on submissions

Get comments for multiple submissions

post

Returns comments for up to 1000 submission IDs in one request.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

Body

application/json

submission_idsstring · uuid[] · max: 1000Required

Responses

200

Comments grouped by submission UUID

application/json

400

Too many submission IDs — max 1000 (DAERR-COM1010)

application/json

post/{app_short}/submissions/comments

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/comments HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "submission_ids": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

{
  "ANY_ADDITIONAL_PROPERTY": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "client_created_at": 1,
      "client_updated_at": 1,
      "user_id": 1,
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "message": "text",
          "client_created_at": 1,
          "client_updated_at": 1,
          "user_id": 1,
          "submission_id": "123e4567-e89b-12d3-a456-426614174000",
          "replies": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Count comments on a submission

get

Returns the total number of comments linked to a submission.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Submission identifier (UUID)

Responses

200

Total number of comments

application/json

countintegerOptional

Total number of comments linked to the submission

get/{app_short}/submissions/{id}/comments/count

HTTPcURLJavaScriptPython

GET /{app_short}/submissions/{id}/comments/count HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Total number of comments

{
  "count": 1
}

List comments on a submission

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Responses

200

List of comments (including replies)

application/json

idstring · uuidOptional

Comment identifier (UUID v4)

messagestring · max: 1000Optional

Plain text only — no HTML or script tags

client_created_atinteger · int64Optional

Client-side creation timestamp (Unix timestamp)

client_updated_atinteger · int64Optional

Client-side update timestamp (Unix timestamp)

user_idintegerOptional

submission_idstring · uuidOptional

403

Access to submission forbidden (DAERR-COM1000)

application/json

404

Submission not found (DAERR-COM1006)

application/json

get/{app_short}/submissions/{id}/comments

HTTPcURLJavaScriptPython

GET /{app_short}/submissions/{id}/comments HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "message": "text",
    "client_created_at": 1,
    "client_updated_at": 1,
    "user_id": 1,
    "submission_id": "123e4567-e89b-12d3-a456-426614174000",
    "replies": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "message": "text",
        "client_created_at": 1,
        "client_updated_at": 1,
        "user_id": 1,
        "submission_id": "123e4567-e89b-12d3-a456-426614174000",
        "replies": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "message": "text",
            "client_created_at": 1,
            "client_updated_at": 1,
            "user_id": 1,
            "submission_id": "123e4567-e89b-12d3-a456-426614174000",
            "replies": "[Circular Reference]"
          }
        ]
      }
    ]
  }
]

Create a comment on a submission

post

Adds a new comment. Plain text only — no HTML or script content. Maximum 1000 characters. Supports an optional client-supplied UUID.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

Body

application/json

idstring · uuidOptional

Optional client-supplied UUID v4

messagestring · max: 1000Required

Plain text only — no HTML, script tags, or dangerous characters

client_created_atinteger · int64Optional

Unix timestamp

client_updated_atinteger · int64Optional

Unix timestamp

Responses

200

Comment created

application/json

idstring · uuidOptional

Comment identifier (UUID v4)

messagestring · max: 1000Optional

Plain text only — no HTML or script tags

client_created_atinteger · int64Optional

Client-side creation timestamp (Unix timestamp)

client_updated_atinteger · int64Optional

Client-side update timestamp (Unix timestamp)

user_idintegerOptional

submission_idstring · uuidOptional

400

Validation error — missing message (DAERR-COM1002), too long (DAERR-COM1003), invalid date (DAERR-COM1004), invalid characters (DAERR-COM1005), invalid UUID (DAERR-COM1009), or comment limit reached (DAERR-COM1012)

application/json

403

Access forbidden (DAERR-COM1000)

application/json

post/{app_short}/submissions/{id}/comments

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/{id}/comments HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "client_created_at": 1,
  "client_updated_at": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "client_created_at": 1,
  "client_updated_at": 1,
  "user_id": 1,
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "client_created_at": 1,
      "client_updated_at": 1,
      "user_id": 1,
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "message": "text",
          "client_created_at": 1,
          "client_updated_at": 1,
          "user_id": 1,
          "submission_id": "123e4567-e89b-12d3-a456-426614174000",
          "replies": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Update a comment

put

Updates the text of a comment. Users can only update their own comments (DAERR-COM1008).

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

comment_idstring · uuidRequired

Body

application/json

idstring · uuidOptional

Optional client-supplied UUID v4

messagestring · max: 1000Required

Plain text only — no HTML, script tags, or dangerous characters

client_created_atinteger · int64Optional

Unix timestamp

client_updated_atinteger · int64Optional

Unix timestamp

Responses

200

Comment updated

application/json

idstring · uuidOptional

Comment identifier (UUID v4)

messagestring · max: 1000Optional

Plain text only — no HTML or script tags

client_created_atinteger · int64Optional

Client-side creation timestamp (Unix timestamp)

client_updated_atinteger · int64Optional

Client-side update timestamp (Unix timestamp)

user_idintegerOptional

submission_idstring · uuidOptional

403

Not allowed to update this comment (DAERR-COM1008)

application/json

404

Comment not found (DAERR-COM1001)

application/json

put/{app_short}/submissions/{id}/comments/{comment_id}

HTTPcURLJavaScriptPython

PUT /{app_short}/submissions/{id}/comments/{comment_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "client_created_at": 1,
  "client_updated_at": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "client_created_at": 1,
  "client_updated_at": 1,
  "user_id": 1,
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "client_created_at": 1,
      "client_updated_at": 1,
      "user_id": 1,
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "message": "text",
          "client_created_at": 1,
          "client_updated_at": 1,
          "user_id": 1,
          "submission_id": "123e4567-e89b-12d3-a456-426614174000",
          "replies": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}

Delete a comment

delete

Deletes a comment. Users can only delete their own comments (DAERR-COM1007).

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

comment_idstring · uuidRequired

Responses

204

Comment deleted

No content

403

Not allowed to delete this comment (DAERR-COM1007)

application/json

404

Comment not found (DAERR-COM1001)

application/json

delete/{app_short}/submissions/{id}/comments/{comment_id}

HTTPcURLJavaScriptPython

DELETE /{app_short}/submissions/{id}/comments/{comment_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Reply to a comment

post

Adds a reply to a first-level comment (max thread depth is 2). Replying to a reply is not allowed (DAERR-COM1011).

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

app_shortstringRequired

Short name of the workspace instance (e.g. daxium-test)

idstring · uuidRequired

comment_idstring · uuidRequired

Body

application/json

idstring · uuidOptional

Optional client-supplied UUID v4

messagestring · max: 1000Required

Plain text only — no HTML, script tags, or dangerous characters

client_created_atinteger · int64Optional

Unix timestamp

client_updated_atinteger · int64Optional

Unix timestamp

Responses

200

Reply created

application/json

idstring · uuidOptional

Comment identifier (UUID v4)

messagestring · max: 1000Optional

Plain text only — no HTML or script tags

client_created_atinteger · int64Optional

Client-side creation timestamp (Unix timestamp)

client_updated_atinteger · int64Optional

Client-side update timestamp (Unix timestamp)

user_idintegerOptional

submission_idstring · uuidOptional

403

Cannot reply to a second-level comment (DAERR-COM1011)

application/json

post/{app_short}/submissions/{id}/comments/{comment_id}/replies

HTTPcURLJavaScriptPython

POST /{app_short}/submissions/{id}/comments/{comment_id}/replies HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "client_created_at": 1,
  "client_updated_at": 1
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "client_created_at": 1,
  "client_updated_at": 1,
  "user_id": 1,
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "replies": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "client_created_at": 1,
      "client_updated_at": 1,
      "user_id": 1,
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "replies": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "message": "text",
          "client_created_at": 1,
          "client_updated_at": 1,
          "user_id": 1,
          "submission_id": "123e4567-e89b-12d3-a456-426614174000",
          "replies": [
            "[Circular Reference]"
          ]
        }
      ]
    }
  ]
}