Comments

The messages of the portal's Comments block, exchanged between the tenant and your team. An internal comment is visible only in the dashboard.

Command	HTTP	Description
`comments list`	`GET /v1/comments`	List comments
`comments create`	`POST /v1/comments`	Create comment
`comments get`	`GET /v1/comments/{id}`	Get comment
`comments delete`	`DELETE /v1/comments/{id}`	Delete comment

Examples

--params carries query, path and header parameters (id, page, filters, X-Workspace-Id); --json carries the request body; --fields limits which fields come back — worth using on every list/get to save context. See Global flags for the full reference.

# List comments
kobana dashboards comments list \
  --params '{"tenant_id": "TENANT_ID"}' \
  --fields "id,author_name,body,created_at"

# Create comment
kobana dashboards comments create \
  --json '{"tenant_id": "TENANT_ID", "body": "Recebemos o seu documento."}'

# Delete comment
kobana dashboards comments delete --params '{"id": "COMMENT_ID"}' --dry-run

Next steps

Checklists
Schema introspection — every parameter this resource accepts.

Examples​

Next steps​

Examples

Next steps