directus/docs/reference/system/comments.md

description, pageClass

description	pageClass
REST and GraphQL API documentation on the comments in Directus.	page-reference

Comments

Comments are a collaboration tool and can be left on items from the sidebar.

The Comment Object

collection string
Collection identifier in which the item resides.

id uuid
Unique identifier for the object.

item string
The item the comment is created for.

comment string
User comment. This will store the comments that show up in the right sidebar of the item edit page in the Data Studio.

date_created timestamp
Timestamp in ISO8601 when the comment was created.

date_updated timestamp
Timestamp in ISO8601 when the comment was last updated.

user_created many-to-one
The user who created the comment. Many-to-one to users.

user_updated many-to-one
The user who last updated the comment. Many-to-one to users.

{
	"collection": "articles",
	"id": "2fab3b9d-0543-4b87-8a30-3c5ee66fedf1",
	"item": "15",
	"comment": "This is a comment on an article",
	"date_created": "2023-01-15T09:14:52Z",
	"date_updated": "2023-01-15T09:00:00Z",
	"user_created": "12e62fd0-29c7-4fd3-b3d3-c7a39933e8af",
	"user_updated": "12e62fd0-29c7-4fd3-b3d3-c7a39933e8af"
}

Get Comments

Returns a list of comments.

Request

GET /comments

SEARCH /comments

If using SEARCH you can provide a query object as the body of your request.

Learn more about SEARCH.

POST /graphql/system

type Query {
	flows: [directus_comments]
}

import { createDirectus, rest, readComments } from '@directus/sdk';

const client = createDirectus('https://directus.example.com').with(rest());

const result = await client.request(readComments(query));

Query Parameters

Supports all global query parameters.

Returns

An array of up to limit comment objects. If no items are available, data will be an empty array.

Get Comment by ID

Returns a single comment by primary key.

Request

GET /comments/:id

POST /graphql/system

type Query {
	comment_by_id(id: ID!): directus_comments
}

import { createDirectus, rest, readComment } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(readComment(comment_id, query_object));

Query Parameters

Supports all global query parameters.

Response

Returns a comment object if a valid identifier was provided.

Create a Comment

Create a new comment. This action is only available to authenticated users.

Request

POST /comments

Provide a comment object as the body of your request.

POST /graphql/system

type Mutation {
	create_comments_item(data: create_directus_comments_input): directus_comments
}

import { createDirectus, rest, createComment } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(createComment(comment_object));

Query Parameters

Supports all global query parameters.

Request Body

A partial comment object.

Response

Returns the comment object of the comment that was created.

Create Multiple Comments

Create multiple new comments. This action is only available to authenticated users.

Request

POST /comments

Provide an array of comment objects as the body of your request.

POST /graphql/system

type Mutation {
	create_comments_items(data: [create_directus_comments_input]): [directus_comments]
}

import { createDirectus, rest, createComments } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(createComments(comment_object_array));

Query Parameters

Supports all global query parameters.

Request Body

An array of partial comment objects. name is required.

Response

Returns an array of comment objects of the comments that were created.

Update a Comment

Update an existing comment. This action is only available to authenticated users.

Request

PATCH /comments/:id

Provide a partial comment object as the body of your request.

POST /graphql/system

type Mutation {
	update_comments_item(id: ID!, data: update_directus_comments_input): directus_comments
}

import { createDirectus, rest, updateComment } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(updateComment(comment_id, partial_comment_object));

Query Parameters

Supports all global query parameters.

Request Body

A partial comment object.

Response

Returns the comment object of the comment that was updated.

Update Multiple Comments

Update multiple existing comments. This action is only available to authenticated users.

Request

PATCH /comments

{
	"keys": comment_id_array,
	"data": partial_comment_objects
}

POST /graphql/system

type Mutation {
	update_comments_items(ids: [ID!]!, data: update_directus_comments_input): [directus_comments]
}

import { createDirectus, rest, updateComments } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(updateComments(comment_id_array, partial_comment_object));

Query Parameters

Supports all global query parameters.

Request Body

keys Required
Array of primary keys of the comments you'd like to update.

data Required
Any of the comment object's properties.

Response

Returns the comment objects of the comments that were updated.

Delete a Comment

Delete an existing comment. This action is only available to authenticated users.

Request

DELETE /comments/:id

POST /graphql/system

type Mutation {
	delete_comments_item(id: ID!): delete_one
}

import { createDirectus, rest, deleteComment } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(deleteComment(comment_id));

Response

Empty body.

Delete Multiple Comments

Delete multiple existing comments. This action is only available to authenticated users.

Request

DELETE /comments

Provide an array of item IDs as your request body.

POST /graphql/system

type Mutation {
	delete_comments_items(ids: [ID!]!): delete_many
}

import { createDirectus, rest, deleteComments } from '@directus/sdk';

const client = createDirectus('directus_project_url').with(rest());

const result = await client.request(deleteComments(comment_id_array));

Request Body

An array of comment primary keys.

Returns

Empty body.