Comments

List comments for a record

get

Retrieves all comments associated with a specific record in a schema. Comments provide a way to add collaborative notes and discussions to individual records. Only schemas with the 'commentable' property set to true support comments.

Path parameters

schemaIdstring · uuidRequired

Unique identifier (UUID) of the schema containing the record

Example: 550e8400-e29b-41d4-a716-446655440000

recordIdstring · uuidRequired

Unique identifier (UUID) of the record to get comments for

Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890

Responses

200

Comments retrieved successfully

application/json

400

Invalid ID format - Either schemaId or recordId is not a valid UUID

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

get

/api/comment/{schemaId}/{recordId}

HTTPcURLJavaScriptPython

GET /api/comment/{schemaId}/{recordId} HTTP/1.1
Host: api-z2.zinkee.com
Accept: */*

[
  {
    "id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
    "registerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdAt": "2024-01-15T10:30:00.000Z",
    "createdBy": "[email protected]",
    "content": [
      {
        "type": "TEXT",
        "value": "This customer requires priority support."
      }
    ]
  },
  {
    "id": "d2e3f4a5-b6c7-8901-def0-234567890123",
    "registerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "createdAt": "2024-01-16T14:45:00.000Z",
    "createdBy": "[email protected]",
    "content": [
      {
        "type": "TEXT",
        "value": "Acknowledged. Priority flag has been set."
      }
    ]
  }
]

Create a comment on a record

post

Creates a new comment associated with a specific record in a schema. Comments allow users to add notes, feedback, or discussions to individual data records.

Requirements:

• The schema must have commentable: true to support comments

• Both schemaId and recordId must be valid UUIDs

• Content cannot be empty

The comment will be timestamped and attributed to the API (for programmatic access) or the authenticated user (for UI access).

Body

application/json

idstring · uuidOptional

schemaIdstring · uuidOptional

recordIdstring · uuidOptional

Responses

200

Comment created successfully

application/json

400

Invalid input - Missing required fields (schemaId, recordId, or content)

application/json

401

Unauthorized - Invalid or missing JWT token

application/json

post

/api/comment/create

HTTPcURLJavaScriptPython

POST /api/comment/create HTTP/1.1
Host: api-z2.zinkee.com
Content-Type: application/json
Accept: */*
Content-Length: 200

{
  "schemaId": "550e8400-e29b-41d4-a716-446655440000",
  "recordId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "content": [
    {
      "type": "TEXT",
      "value": "This record needs to be reviewed before the end of the week."
    }
  ]
}

{
  "id": "e5f6a7b8-c9d0-1234-ef01-456789012345",
  "registerId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "createdAt": "2024-01-20T15:30:00.000Z",
  "createdBy": "API",
  "content": [
    {
      "type": "TEXT",
      "value": "This record needs to be reviewed before the end of the week."
    }
  ]
}