Ctrlk
Login
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Comments

Manage comments and replies on submissions

List comments on a submission

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

The comments of the submission, most recent last.

application/json
get/{app_short}/submissions/{submission_id}/comments
GET /{app_short}/submissions/{submission_id}/comments HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "comments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": 1,
        "full_name": "text"
      },
      "client_created_at": 1,
      "client_updated_at": 1,
      "replies_count": 1
    }
  ]
}

Create a comment on a submission

post
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
messagestringRequired
parent_idstring · uuidOptional

Set it to reply to an existing comment.

Responses
201

The comment has been created.

application/json

A comment posted on a submission, or a reply to another comment.

idstring · uuidOptional
messagestringOptional
submission_idstring · uuidOptional
parent_idstring · uuidOptional

Identifier of the comment being replied to. Absent on a top-level comment.

client_created_atintegerOptional

Creation timestamp, as sent by the client.

client_updated_atintegerOptional

Last update timestamp, as sent by the client.

replies_countintegerOptional

Number of replies to this comment. Only present when listing the comments of a submission, not on other operations returning a comment.

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

{
  "message": "text",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": 1,
    "full_name": "text"
  },
  "client_created_at": 1,
  "client_updated_at": 1,
  "replies_count": 1
}

List the replies to a comment

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequired
comment_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

The replies to the comment.

application/json
get/{app_short}/submissions/{submission_id}/comments/{comment_id}/replies
GET /{app_short}/submissions/{submission_id}/comments/{comment_id}/replies HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "comments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": 1,
        "full_name": "text"
      },
      "client_created_at": 1,
      "client_updated_at": 1,
      "replies_count": 1
    }
  ]
}

Get comments for multiple submissions

post
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
Responses
200

The comments of the requested submissions. Empty when no identifier is sent.

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

{
  "submission_ids": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}
{
  "comments": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "message": "text",
      "submission_id": "123e4567-e89b-12d3-a456-426614174000",
      "parent_id": "123e4567-e89b-12d3-a456-426614174000",
      "user": {
        "id": 1,
        "full_name": "text"
      },
      "client_created_at": 1,
      "client_updated_at": 1,
      "replies_count": 1
    }
  ]
}

Count comments on a submission

get
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequired
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
200

Number of comments on the submission.

application/json
countintegerOptional
get/{app_short}/submissions/{submission_id}/comments/count
GET /{app_short}/submissions/{submission_id}/comments/count HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "count": 1
}

Update a comment

put
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequired
comment_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Body
messagestringRequired
parent_idstring · uuidOptional

Set it to reply to an existing comment.

Responses
200

The updated comment.

application/json

A comment posted on a submission, or a reply to another comment.

idstring · uuidOptional
messagestringOptional
submission_idstring · uuidOptional
parent_idstring · uuidOptional

Identifier of the comment being replied to. Absent on a top-level comment.

client_created_atintegerOptional

Creation timestamp, as sent by the client.

client_updated_atintegerOptional

Last update timestamp, as sent by the client.

replies_countintegerOptional

Number of replies to this comment. Only present when listing the comments of a submission, not on other operations returning a comment.

put/{app_short}/submissions/{submission_id}/comments/{comment_id}
PUT /{app_short}/submissions/{submission_id}/comments/{comment_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 69

{
  "message": "text",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "message": "text",
  "submission_id": "123e4567-e89b-12d3-a456-426614174000",
  "parent_id": "123e4567-e89b-12d3-a456-426614174000",
  "user": {
    "id": 1,
    "full_name": "text"
  },
  "client_created_at": 1,
  "client_updated_at": 1,
  "replies_count": 1
}

Delete a comment

delete
Authorizations
OAuth2passwordRequired

Send the access token as Authorization: Bearer <token>.

Token URL: Refresh URL:
OAuth2authorizationCodeRequired

Send the access token as Authorization: Bearer <token>.

Authorization URL: Token URL: Refresh URL:
Path parameters
app_shortstringRequired

Short name of the workspace, as found in the URL of the back-office.

submission_idstringRequired
comment_idstringRequiredPattern: [0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}
Header parameters
X-Accept-Versionstring · enumOptional

API version to apply. Defaults to v1.0 when omitted; an unknown value falls back to the latest version.

Default: v1.3Possible values:
Responses
204

The comment has been deleted.

No content
delete/{app_short}/submissions/{submission_id}/comments/{comment_id}
DELETE /{app_short}/submissions/{submission_id}/comments/{comment_id} HTTP/1.1
Host: api.daxium-air.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

No content
PreviousSubmission Relations
NextCustom Applications

Last updated

Was this helpful?